diff --git a/README.md b/README.md index 0db96617a..b6b3ba858 100644 --- a/README.md +++ b/README.md @@ -8,55 +8,81 @@ 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. -Similar idea to godot 4.0, but taken in a completely different direction. +Similar idea going from godot 3.x to godot 4.x, 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. +Currently this engine is a weird amalgamation of godot 3.x, 4.x, and lots of custom features. + +Most of the design decisions went into making everything simple for people that knows (or wants to know) what is going on. + +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 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 +It provides a comprehensive set of common tools, 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://github.com/Relintai/pandemonium_engine_docs/blob/master/03_usage/13_platform/01_consoles.md). ## Free, open source and community-driven -Pandemonium is completely free and open source under the very permissive [MIT license](https://godotengine.org/license). +Pandemonium is completely free and open source under the very permissive +[MIT license](https://github.com/Relintai/pandemonium_engine/blob/master/LICENSE.txt). No strings attached, no royalties, nothing. The users' games are theirs, down to the last line of engine code. -Godot's development is fully independent and +Pandemonium's development is fully independent and community-driven, empowering users to help shape their engine to match their expectations. It is supported by the [Software Freedom Conservancy](https://sfconservancy.org/) not-for-profit. +### Godot + Before being open sourced in [February 2014](https://github.com/godotengine/godot/commit/0b806ee0fc9097fa7bda7ac0109191c9c5e0a1ac), Godot had been developed by [Juan Linietsky](https://github.com/reduz) and [Ariel Manzur](https://github.com/punto-) (both still maintaining the project) for several years as an in-house engine, used to publish several work-for-hire titles. +### Pandemonium + +The Godot engine developers decided to remove the GLES2 backend in Godot 4.x so they can pursue the more modern graphics API-s. + +After quite a while of thinking and experimentation however I decided that I still need (and want) the GLES2 renderer for my games, +I also needed some of the new features from godot 4.x. + +So in early 2022 I decided that I'll fork godot 3.x, and backport anything that I +need for my games / projects. While here I also used the opportunity to modularize the engine more, +and fix issues I had with it. I also added my engine modules to it by default, and +ended up writing lots of custom things. + ## Getting the engine ### Binary downloads -I don't have anything (like 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), or the releases tab [[here]](https://github.com/Relintai/pandemonium_engine/releases). +You can download binaries from the github actions tab [[here]](https://github.com/Relintai/pandemonium_engine), +or the releases tab [[here]](https://github.com/Relintai/pandemonium_engine/releases). ### Compiling from source -Compiling is exactly the same as for Godot, so [See the official Godot docs](https://docs.godotengine.org/en/latest/development/compiling/) +[See the official docs](https://github.com/Relintai/pandemonium_engine_docs/tree/master/05_engine_development/01_compiling) for compilation instructions for every supported platform. ## Documentation and demos -Some of the documentation is available in this repo under the doc/engine folder. [[Here]](https://github.com/Relintai/pandemonium_engine/tree/master/doc/engine). - -You can also look at the official 3.x Godot documentation, it will work mostly (sometimes with trivial modifications). 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 documentation is available [[Here]](https://github.com/Relintai/pandemonium_engine_docs). The class docs are accessible from the editor. You can also look at the official pandemonium demos in their own [GitHub repository](https://github.com/Relintai/pandemonium_demo_projects). -It's also worth looking at official godot 3.x resources, like this [awesome Godot list](https://github.com/godotengine/awesome-godot), and there are also a number of other [godot learning resources](https://docs.godotengine.org/en/latest/community/tutorials.html) +You can also look at the official 3.x Godot documentation, it will work mostly (sometimes with trivial modifications). +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). + +It's also worth looking at official godot 3.x resources, like this [awesome Godot list](https://github.com/godotengine/awesome-godot), +and there are also a number of other [godot learning resources](https://docs.godotengine.org/en/latest/community/tutorials.html) provided by the community, such as text and video tutorials, demos, etc. +