Relintai/pandemonium_engine
1
0
Fork 0
mirror of https://github.com/Relintai/pandemonium_engine.git synced 2025-04-22 11:21:18 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'Relintai:master' into master

Browse Source
This commit is contained in:
Nguyen Truong An 2024-09-30 16:10:42 +02:00 committed by GitHub
commit ad5544497a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
4 changed files with 57 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
CONTRIBUTING.md
View File

@ -5,8 +5,6 @@
- [Reporting bugs](#reporting-bugs)
- [Proposing features or improvements](#proposing-features-or-improvements)
- [Contributing pull requests](#contributing-pull-requests)
- [Contributing to Godot's translation](#contributing-to-godots-translation)
- [Communicating with developers](#communicating-with-developers)
**Please read the first section before reporting a bug!**
@ -29,11 +27,11 @@ from there if it's a duplicate.
### Specify the platform
Godot runs on a large variety of platforms and operating systems and devices.
Pandemonium runs on a large variety of platforms and operating systems and devices.
**In your bug reports, please always specify:**
- Operating system and version (e.g. Windows 10, macOS 10.15, Ubuntu 19.10)
- Godot version (e.g. 3.2, 3.1.2, or the Git commit hash if you're using a development branch)
- Pandemonium version (e.g. 3.2, 3.1.2, or the Git commit hash if you're using a development branch)
For bugs that are likely OS-specific and/or graphics-related, please also specify:
@ -81,18 +79,7 @@ it'll be considered too difficult to diagnose.
Now that you've read the guidelines, click the link below to create a
bug report:
- **[Report a bug](https://github.com/godotengine/godot/issues/new?assignees=&labels=&template=bug_report.yml)**
## Proposing features or improvements
**Since August 2019, the main issue tracker no longer accepts feature proposals.**
Instead, head to the [Godot Proposals repository](https://github.com/godotengine/godot-proposals)
and follow the instructions in the README file. High-quality feature proposals
are more likely to be well-received by the maintainers and community, so do
your best :)
See [this article](https://godotengine.org/article/introducing-godot-proposals-repository)
for detailed rationale on this change.
- **[Report a bug](https://github.com/Relintai/pandemonium_engine/issues/new)**
## Contributing pull requests
@ -115,10 +102,10 @@ recommend that you have a look at it to know what's important to take into
account for a PR to be considered for merging.
In addition to the following tips, also take a look at the
[Engine development guide](https://docs.godotengine.org/en/latest/development/cpp/)
for an introduction to developing on Godot.
[Engine development guide](https://github.com/Relintai/pandemonium_engine_docs/tree/master/05_engine_development/02_cpp)
for an introduction to developing on Pandemonium.
The [Contributing docs](https://docs.godotengine.org/en/latest/community/contributing/index.html)
The [Contributing docs](https://github.com/Relintai/pandemonium_engine_docs/tree/master/06_community/contributing)
also have important information on the PR workflow and the code style we use.
### Document your changes
@ -128,10 +115,10 @@ scripting APIs, you **must** update the class reference to document those.
This is to ensure the documentation coverage doesn't decrease as contributions
are merged.
[Update the documentation template](https://docs.godotengine.org/en/latest/community/contributing/updating_the_class_reference.html#updating-the-documentation-template)
[Update the documentation template](https://github.com/Relintai/pandemonium_engine_docs/blob/master/06_community/contributing/12_updating_the_class_reference.md)
using your compiled binary, then fill in the descriptions.
Follow the style guide described in the
[Docs writing guidelines](https://docs.godotengine.org/en/latest/community/contributing/docs_writing_guidelines.html).
[Docs writing guidelines](https://github.com/Relintai/pandemonium_engine_docs/blob/master/06_community/contributing/16_docs_writing_guidelines.md).
If your pull request modifies parts of the code in a non-obvious way, make sure
to add comments in the code as well. This helps other people understand the
@ -156,7 +143,7 @@ Internet).
This [Git style guide](https://github.com/agis-/git-style-guide) has some
good practices to have in mind.
See our [PR workflow](https://docs.godotengine.org/en/latest/community/contributing/pr_workflow.html)
See our [PR workflow](https://github.com/Relintai/pandemonium_engine_docs/blob/master/06_community/contributing/04_pr_workflow.md)
documentation for tips on using Git, amending commits and rebasing branches.
### Format your commit messages with readability in mind
@ -180,12 +167,12 @@ description is also manually wrapped at 80 chars for readability):
```text
Prevent French fries carbonization by fixing heat regulation
When using the French fries frying module, Godot would not regulate the heat
When using the French fries frying module, Pandemonium would not regulate the heat
and thus bring the oil bath to supercritical liquid conditions, thus causing
unwanted side effects in the physics engine.
By fixing the regulation system via an added binding to the internal feature,
this commit now ensures that Godot will not go past the ebullition temperature
this commit now ensures that Pandemonium will not go past the ebullition temperature
of cooking oil under normal atmospheric conditions.
Fixes #1789, long live the Realm!
@ -195,42 +182,3 @@ Fixes #1789, long live the Realm!
feature, *please* edit the commit title to something meaningful. Commits named
"Update my_file.cpp" won't be accepted.
## Contributing to Godot's translation
You can contribute to Godot's translation from the [Hosted
Weblate](https://hosted.weblate.org/projects/godot-engine/godot), an open
source and web-based translation platform. Please refer to the [translation
readme](editor/translations/README.md) for more information.
You can also help translate [Godot's
documentation](https://hosted.weblate.org/projects/godot-engine/godot-docs/)
on Weblate.
## Communicating with developers
The Godot Engine community has [many communication
channels](https://godotengine.org/community), some used more for user-level
discussions and support, others more for development discussions.
To communicate with developers (e.g. to discuss a feature you want to implement
or a bug you want to fix), the following channels can be used:
- [Godot Contributors Chat](https://chat.godotengine.org): You will
find most core developers there, so it's the go-to platform for direct chat
about Godot Engine development. Feel free to start discussing something there
to get some early feedback before writing up a detailed proposal in a GitHub
issue.
- [Bug tracker](https://github.com/godotengine/godot/issues): If there is an
existing issue about a topic you want to discuss, just add a comment to it -
many developers watch the repository and will get a notification. You can
also create a new issue - please keep in mind to create issues only to
discuss quite specific points about the development, and not general user
feedback or support requests.
- [Feature proposals](https://github.com/godotengine/godot-proposals/issues):
To propose a new feature, we have a dedicated issue tracker for that. Don't
hesitate to start by talking about your idea on the Godot Contributors Chat
to make sure that it makes sense in Godot's context.
Thanks for your interest in contributing!
—The Godot development team

14
COPYRIGHT.txt
View File

@ -37,15 +37,15 @@
-----------------------------------------------------------------------
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: Godot Engine
Upstream-Contact: Rémi Verschelde <contact@godotengine.org>
Source: https://github.com/godotengine/godot
Upstream-Name: Pandemonium Engine
Upstream-Contact: Péter Magyar <relintai@protonmail.com>
Source: https://github.com/Relintai/pandemonium_engine
Files: *
Comment: Pandemonium Engine
Copyright: 2007-2022, Juan Linietsky, Ariel Manzur.
Copyright: 2022-present, Péter Magyar.
2014-2022, Godot Engine contributors.
2022-2023, Péter Magyar.
2007-2022, Juan Linietsky, Ariel Manzur.
License: Expat
Files: ./icon.png
@ -53,8 +53,8 @@ Files: ./icon.png
./logo.png
./logo.svg
Comment: Pandemonium Engine logo
Copyright: 2017, Andrea Calabró.
2022, Péter Magyar.
Copyright: 2022-present, Péter Magyar.
2017, Andrea Calabró.
License: CC-BY-4.0
Files: ./core/math/convex_hull.cpp

2
LOGO_LICENSE.md
View File

@ -1,6 +1,6 @@
Pandemonium Engine Logo
Copyright (c) 2022-present Péter Magyar
Copyright (c) 2017 Andrea Calabró
Copyright (c) 2022-2023 Péter Magyar
This work is licensed under a Creative Commons Attribution 4.0 International
License (CC-BY-4.0 International) <https://creativecommons.org/licenses/by/4.0/>.

50
README.md
View File

@ -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/actions),
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.