Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2024-11-21 16:37:20 +01:00
Code Issues Packages Projects Releases Wiki Activity

Rework the readme.

Browse Source
This commit is contained in:
Relintai 2022-03-20 10:33:02 +01:00
parent cff20866e4
commit c5dc3db94d
1 changed files with 18 additions and 42 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
README.md
View File

@ -1,29 +1,25 @@
# Pandemonium Engine
A 3.x godot engine fork where I hack and slash and cause mayhem and destruction to all things good and godot.
<p align="center">
<a href="https://godotengine.org">
<img src="logo_outlined.svg" width="400" alt="Pandemonium Engine logo">
</a>
</p>
Similar idea to godot 4.0, but taken in a completely different direction:
A 3.x [Godot Engine](https://godotengine.org) fork where I hack and slash and cause mayhem and destruction to all things good and godot.
- I'm planning to remove all (or almost all) engine modules that I don't use.
- I'm planning to remove all (or almost all) drivers (like for more obscure formats) that I don't use.
- I'm planning to simplify things as much as I can.
- I'll probably import some unfinished prs from godot's repo.
- This fork will have all modules thet I created and actually use.
- I'll also try to strip most features that I don't use and I think is not needed for my projects. (AssetLib, TileMap - I have terraman2D -, GridMap (I have Terraman, Voxelman), Gles3, Lightmaps, GIProbes, VisualScript, GDNative etc.)
- I might create simpler physics engine that can only do collision detection, stuff like this.
- I'll try to simplify things to get better compile times.
- Might even try to go full C.
Similar idea to godot 4.0, but taken in a completely different direction.
It contains all of my currently in use engine modules. See the [changelog](https://github.com/Relintai/pandemonium_engine/blob/master/CHANGELOG.md) for a more comprehensive list of changes.
## 2D and 3D cross-platform game engine
**[Godot Engine](https://godotengine.org) is a feature-packed, cross-platform
game engine to create 2D and 3D games from a unified interface.** It provides a
comprehensive set of [common tools](https://godotengine.org/features), so that users can focus on making games
Pandemonium Engine is a feature-packed, cross-platform game engine to create 2D and 3D games from a unified interface.
It provides a comprehensive set of [common tools](https://godotengine.org/features), so that users can focus on making games
without having to reinvent the wheel. Games can be exported with one click to a
number of platforms, including the major desktop platforms (Linux, macOS,
Windows), mobile platforms (Android, iOS), as well as Web-based platforms
(HTML5) and
[consoles](https://docs.godotengine.org/en/latest/tutorials/platform/consoles.html).
(HTML5) and [consoles](https://docs.godotengine.org/en/latest/tutorials/platform/consoles.html).
## Free, open source and community-driven
@ -43,43 +39,23 @@ years as an in-house engine, used to publish several work-for-hire titles.
### Binary downloads
Official binaries for the Godot editor and the export templates can be found
[on the homepage](https://godotengine.org/download).
I don't have anything (lik an official webpage) set up at the moment, but temporarily you can download binaries from the github actions tab [[here]](https://github.com/Relintai/pandemonium_engine/actions).
### Compiling from source
[See the official docs](https://docs.godotengine.org/en/latest/development/compiling/)
Compiling is exactly the same as for Godot, so [See the official Godot docs](https://docs.godotengine.org/en/latest/development/compiling/)
for compilation instructions for every supported platform.
## Community and contributing
Godot is not only an engine but an ever-growing community of users and engine
developers. The main community channels are listed [on the homepage](https://godotengine.org/community).
The best way to get in touch with the core engine developers is to join the
[Godot Contributors Chat](https://chat.godotengine.org).
To get started contributing to the project, see the [contributing guide](CONTRIBUTING.md).
## Documentation and demos
The official documentation is hosted on [ReadTheDocs](https://docs.godotengine.org).
It is maintained by the Godot community in its own [GitHub repository](https://github.com/godotengine/godot-docs).
For basic usage see the official Godot documentation. It is hosted on [ReadTheDocs](https://docs.godotengine.org), and
is maintained by the Godot community in its own [GitHub repository](https://github.com/godotengine/godot-docs).
The [class reference](https://docs.godotengine.org/en/latest/classes/)
is also accessible from the Godot editor.
The is accessible from the editor.
We also maintain official demos in their own [GitHub repository](https://github.com/godotengine/godot-demo-projects)
You can also look at the official godot demos in their own [GitHub repository](https://github.com/godotengine/godot-demo-projects)
as well as a list of [awesome Godot community resources](https://github.com/godotengine/awesome-godot).
There are also a number of other
[learning resources](https://docs.godotengine.org/en/latest/community/tutorials.html)
provided by the community, such as text and video tutorials, demos, etc.
Consult the [community channels](https://godotengine.org/community)
for more information.
[![Actions Build Status](https://github.com/godotengine/godot/workflows/Godot/badge.svg?branch=master)](https://github.com/godotengine/godot/actions)
[![Code Triagers Badge](https://www.codetriage.com/godotengine/godot/badges/users.svg)](https://www.codetriage.com/godotengine/godot)
[![Translate on Weblate](https://hosted.weblate.org/widgets/godot-engine/-/godot/svg-badge.svg)](https://hosted.weblate.org/engage/godot-engine/?utm_source=widget)
[![Total alerts on LGTM](https://img.shields.io/lgtm/alerts/g/godotengine/godot.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/godotengine/godot/alerts)
[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/godotengine/godot)](https://www.tickgit.com/browse?repo=github.com/godotengine/godot)