mirror of
https://github.com/Redot-Engine/redot-engine.git
synced 2025-12-06 15:21:56 -05:00
Fixed some typos and corrected for requests
This commit is contained in:
@@ -1,9 +1,9 @@
|
|||||||
# Contributors guidelines
|
# Contributors guidelines
|
||||||
|
|
||||||
This document summarizes the most important points for people interested in
|
This document summarizes the most important points for people interested in
|
||||||
contributing to Godot, especially via bug reports or pull requests.
|
contributing to Redot, especially via bug reports or pull requests.
|
||||||
|
|
||||||
The Godot documentation has a dedicated [Contributing section](https://docs.godotengine.org/en/latest/contributing/how_to_contribute.html)
|
The [Redot Discord](https://discord.gg/redot) documentation has a dedicated Contributing section
|
||||||
which details these points and more, and is a recommended read.
|
which details these points and more, and is a recommended read.
|
||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
@@ -16,20 +16,18 @@ which details these points and more, and is a recommended read.
|
|||||||
|
|
||||||
## Reporting bugs
|
## Reporting bugs
|
||||||
|
|
||||||
Report bugs [here](https://github.com/redotengine/rdot/issues/new?assignees=&labels=&template=bug_report.yml).
|
Report bugs [here](https://github.com/Redot-Engine/redot-engine/issues/new?assignees=&labels=&template=bug_report.yml).
|
||||||
Please follow the instructions in the template when you do.
|
Please follow the instructions in the template when you do.
|
||||||
|
|
||||||
Notably, please include a Minimal Reproduction Project (MRP), which is a small
|
Notably, please include a Minimal Reproduction Project (MRP), which is a small
|
||||||
Godot project which reproduces the issue, with no unnecessary files included.
|
Redot project which reproduces the issue, with no unnecessary files included.
|
||||||
Be sure to not include the `.godot` folder in the archive to save space.
|
Be sure to not include the `.godot` folder in the archive to save space.
|
||||||
|
|
||||||
Make sure that the bug you are experiencing is reproducible in the latest Godot
|
Make sure that the bug you are experiencing is reproducible in the latest Redot
|
||||||
releases. You can find an overview of all Godot releases [on the website](https://godotengine.org/download/archive/)
|
releases. It's worth testing against both the latest stable release and the
|
||||||
to confirm whether your current version is the latest one. It's worth testing
|
latest dev snapshot for the next Redot release.
|
||||||
against both the latest stable release and the latest dev snapshot for the next
|
|
||||||
Godot release.
|
|
||||||
|
|
||||||
If you run into a bug which wasn't present in an earlier Godot version (what we
|
If you run into a bug which wasn't present in an earlier Redot version (what we
|
||||||
call a _regression_), please mention it and clarify which versions you tested
|
call a _regression_), please mention it and clarify which versions you tested
|
||||||
(both the one(s) working and the one(s) exhibiting the bug).
|
(both the one(s) working and the one(s) exhibiting the bug).
|
||||||
|
|
||||||
@@ -37,8 +35,7 @@ call a _regression_), please mention it and clarify which versions you tested
|
|||||||
|
|
||||||
**The main issue tracker is for bug reports and does not accept feature proposals.**
|
**The main issue tracker is for bug reports and does not accept feature proposals.**
|
||||||
|
|
||||||
Instead, head to the [Godot Proposals repository](https://github.com/godotengine/godot-proposals)
|
Instead, head to the [Redot Discord](https://discord.gg/redot).
|
||||||
and follow the instructions in the README file and issue template.
|
|
||||||
|
|
||||||
## Contributing pull requests
|
## Contributing pull requests
|
||||||
|
|
||||||
@@ -55,18 +52,7 @@ Similar rules can be applied when contributing bug fixes - it's always best to
|
|||||||
discuss the implementation in the bug report first if you are not 100% about
|
discuss the implementation in the bug report first if you are not 100% about
|
||||||
what would be the best fix.
|
what would be the best fix.
|
||||||
|
|
||||||
You can refer to the [Pull request review process](https://docs.godotengine.org/en/latest/contributing/workflow/pr_review_guidelines.html)
|
Visit the [Redot Discord](https://discord.gg/redot) for information and guides related to contribution and pull requests.
|
||||||
for insights into the intended lifecycle of pull requests. This should help you
|
|
||||||
ensure that your pull request fulfills the requirements.
|
|
||||||
|
|
||||||
In addition to the following tips, also take a look at the
|
|
||||||
[Engine development guide](https://docs.godotengine.org/en/latest/contributing/development/index.html)
|
|
||||||
for an introduction to developing on Godot.
|
|
||||||
|
|
||||||
The [Contributing docs](https://docs.godotengine.org/en/latest/contributing/how_to_contribute.html)
|
|
||||||
also have important information on the [PR workflow](https://docs.godotengine.org/en/latest/contributing/workflow/pr_workflow.html)
|
|
||||||
(with a helpful guide for Git usage), and our [Code style guidelines](https://docs.godotengine.org/en/latest/contributing/development/code_style_guidelines.html)
|
|
||||||
which all contributions need to follow.
|
|
||||||
|
|
||||||
### Be mindful of your commits
|
### Be mindful of your commits
|
||||||
|
|
||||||
@@ -84,9 +70,6 @@ stable state, i.e. if your first commit has a bug that you fixed in the second
|
|||||||
commit, try to merge them together before making your pull request. This
|
commit, try to merge them together before making your pull request. This
|
||||||
includes fixing build issues or typos, adding documentation, etc.
|
includes fixing build issues or typos, adding documentation, etc.
|
||||||
|
|
||||||
See our [PR workflow](https://docs.godotengine.org/en/latest/contributing/workflow/pr_workflow.html)
|
|
||||||
documentation for tips on using Git, amending commits and rebasing branches.
|
|
||||||
|
|
||||||
This [Git style guide](https://github.com/agis-/git-style-guide) also has some
|
This [Git style guide](https://github.com/agis-/git-style-guide) also has some
|
||||||
good practices to have in mind.
|
good practices to have in mind.
|
||||||
|
|
||||||
@@ -125,12 +108,12 @@ description is also manually wrapped at 80 chars for readability):
|
|||||||
```text
|
```text
|
||||||
Prevent French fries carbonization by fixing heat regulation
|
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, Redot would not regulate the heat
|
||||||
and thus bring the oil bath to supercritical liquid conditions, thus causing
|
and thus bring the oil bath to supercritical liquid conditions, thus causing
|
||||||
unwanted side effects in the physics engine.
|
unwanted side effects in the physics engine.
|
||||||
|
|
||||||
By fixing the regulation system via an added binding to the internal feature,
|
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 Redot will not go past the ebullition temperature
|
||||||
of cooking oil under normal atmospheric conditions.
|
of cooking oil under normal atmospheric conditions.
|
||||||
```
|
```
|
||||||
|
|
||||||
@@ -182,22 +165,23 @@ for information on writing tests in Godot's C++ codebase.
|
|||||||
You can contribute to Godot translations on [Hosted Weblate](https://hosted.weblate.org/projects/godot-engine/),
|
You can contribute to Godot translations on [Hosted Weblate](https://hosted.weblate.org/projects/godot-engine/),
|
||||||
an open source and web-based translation platform.
|
an open source and web-based translation platform.
|
||||||
|
|
||||||
Please refer to our [editor and documentation localization guidelines](https://docs.godotengine.org/en/latest/contributing/documentation/editor_and_docs_localization.html)
|
Please refer to Godot's [editor and documentation localization guidelines](https://docs.godotengine.org/en/latest/contributing/documentation/editor_and_docs_localization.html)
|
||||||
for an overview of the translation resources and what they correspond to.
|
for an overview of the translation resources and what they correspond to.
|
||||||
|
|
||||||
## Communicating with developers
|
## Communicating with developers
|
||||||
|
|
||||||
|
The Redot Engine community is largely centralized on the [Redot Discord](https://discord.gg/redot) at this time, feel free to drop by!
|
||||||
|
|
||||||
To communicate with developers (e.g. to discuss a feature you want to implement
|
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:
|
or a bug you want to fix), the following channels can be used:
|
||||||
|
|
||||||
- [Redot Contributors Chat](https://discord.gg/redot): You will
|
- [Redot Discord](https://discord.gg/redot): General community chat and development can all be found here.
|
||||||
find most core developers there, so it's the go-to platform for direct chat
|
- [Bug tracker](https://github.com/Redot-Engine/redot-engine/issues): If there is an
|
||||||
about Godot Engine development.
|
|
||||||
- [Bug tracker](https://github.com/redotengine/redot/issues): If there is an
|
|
||||||
existing issue about a topic you want to discuss, you can participate directly.
|
existing issue about a topic you want to discuss, you can participate directly.
|
||||||
If not, you can open a new issue. Please mind the guidelines outlined above
|
If not, you can open a new issue. Please mind the guidelines outlined above
|
||||||
for bug reporting.
|
for bug reporting.
|
||||||
|
- Feature Proposals should be made on the [Redot Discord](https://discord.gg/redot) for now.
|
||||||
|
|
||||||
Thanks for your interest in contributing!
|
Thanks for your interest in contributing!
|
||||||
|
|
||||||
—The Godot development team
|
—Redot Development Community
|
||||||
|
|||||||
60
README.md
60
README.md
@@ -1,78 +1,62 @@
|
|||||||
# Godot Engine
|
# Redot Engine
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://godotengine.org">
|
<a href="https://redotengine.org/">
|
||||||
<img src="logo_outlined.svg" width="400" alt="Godot Engine logo">
|
<img src="logo_outlined.png" width="400" alt="Redot Engine logo">
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## 2D and 3D cross-platform game engine
|
## 2D and 3D cross-platform game engine
|
||||||
|
|
||||||
**[Godot Engine](https://godotengine.org) is a feature-packed, cross-platform
|
**[Redot Engine](https://redotengine.org) is a feature-packed, cross-platform
|
||||||
game engine to create 2D and 3D games from a unified interface.** It provides a
|
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
|
comprehensive set of common tools, so that
|
||||||
users can focus on making games without having to reinvent the wheel. Games can
|
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
|
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
|
platforms (Linux, macOS, Windows), mobile platforms (Android, iOS), as well as
|
||||||
Web-based platforms and [consoles](https://docs.godotengine.org/en/latest/tutorials/platform/consoles.html).
|
Web-based platforms and consoles.
|
||||||
|
|
||||||
## Free, open source and community-driven
|
## Free, open source and community-driven
|
||||||
|
|
||||||
Godot is completely free and open source under the very permissive [MIT license](https://godotengine.org/license).
|
Redot is a completely free and open source fork of Godot under the very permissive MIT license.
|
||||||
No strings attached, no royalties, nothing. The users' games are theirs, down
|
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
|
to the last line of engine code. Redot's development is fully independent and truly
|
||||||
community-driven, empowering users to help shape their engine to match their
|
community-driven, empowering users to help shape their engine to match their
|
||||||
expectations. It is supported by the [Godot Foundation](https://godot.foundation/)
|
expectations.
|
||||||
not-for-profit.
|
|
||||||
|
|
||||||
Before being open sourced in [February 2014](https://github.com/godotengine/godot/commit/0b806ee0fc9097fa7bda7ac0109191c9c5e0a1ac),
|
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
|
Godot had been developed by [Juan Linietsky](https://github.com/reduz) and
|
||||||
[Ariel Manzur](https://github.com/punto-) (both still maintaining the project)
|
[Ariel Manzur](https://github.com/punto-) (both still maintaining Godot)
|
||||||
for several years as an in-house engine, used to publish several work-for-hire
|
for several years as an in-house engine, used to publish several work-for-hire
|
||||||
titles.
|
titles.
|
||||||
|
|
||||||

|
Redot was forked from Godot in [October 2024](https://github.com/Redot-Engine/redot-engine/commit/a12e9de5dd831e1ce0c839f0420b278ef0a6aa5b),
|
||||||
|
intending to improve upon Godot in order to fulfill its potential and contribute to the shared
|
||||||
|
codebase of both through a more genuinely community-driven model than Godot.
|
||||||
|
<p align="center">
|
||||||
|
<img src="screenshot.jpg" width="900" alt="Redot Engine screenshot!">
|
||||||
|
</p>
|
||||||
|
|
||||||
## Getting the engine
|
## Getting the engine
|
||||||
|
|
||||||
### Binary downloads
|
### Binary downloads
|
||||||
|
|
||||||
Official binaries for the Godot editor and the export templates can be found
|
Official binaries for the Redot editor and the export templates will be found
|
||||||
[on the Godot website](https://godotengine.org/download).
|
[on the Redot website](https://redotengine.org/download) once it's set up.
|
||||||
|
|
||||||
### Compiling from source
|
### Compiling from source
|
||||||
|
|
||||||
[See the official docs](https://docs.godotengine.org/en/latest/contributing/development/compiling)
|
[For the time being, see the official Godot docs](https://docs.godotengine.org/en/latest/contributing/development/compiling)
|
||||||
for compilation instructions for every supported platform.
|
for compilation instructions for every supported platform.
|
||||||
|
|
||||||
## Community and contributing
|
## Community and contributing
|
||||||
|
|
||||||
Godot is not only an engine but an ever-growing community of users and engine
|
Redot 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).
|
developers. Please visit our [Discord server](https://discord.gg/redot)!
|
||||||
|
|
||||||
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).
|
To get started contributing to the project, see the [contributing guide](CONTRIBUTING.md).
|
||||||
This document also includes guidelines for reporting bugs.
|
This document also includes guidelines for reporting bugs.
|
||||||
|
|
||||||
## Documentation and demos
|
## Documentation and demos
|
||||||
|
|
||||||
The official documentation is hosted on [Read the Docs](https://docs.godotengine.org).
|
The class reference is accessible from the Redot editor.
|
||||||
It 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.
|
|
||||||
|
|
||||||
We also maintain official 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.
|
|
||||||
|
|
||||||
[](https://www.codetriage.com/godotengine/godot)
|
|
||||||
[](https://hosted.weblate.org/engage/godot-engine/?utm_source=widget)
|
|
||||||
[](https://www.tickgit.com/browse?repo=github.com/godotengine/godot)
|
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 40 KiB |
BIN
screenshot.jpg
Normal file
BIN
screenshot.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 346 KiB |
Reference in New Issue
Block a user