From 0d561636e54bf5371844d1757b3978c40aac5d4f Mon Sep 17 00:00:00 2001 From: Coleisforrobot <62335118+Coleisforrobot@users.noreply.github.com> Date: Mon, 30 Sep 2024 19:43:58 +0100 Subject: [PATCH] Update README.md Removes most references to Godot except where required, rebrand to Redot. --- README.md | 66 ++++++++++++------------------------------------------- 1 file changed, 14 insertions(+), 52 deletions(-) diff --git a/README.md b/README.md index 46a9b2362c1..678a5f3e076 100644 --- a/README.md +++ b/README.md @@ -1,78 +1,40 @@ -# Godot Engine +# Redot Engine

- - Godot Engine logo - + Redot Engine logo

## 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 +**[Redot Engine](https://www.redotengine.org) is a feature-packed, cross-platform +game engine to create 2D and 3D games from a unified interface, based on Godot Engine.** 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 and [consoles](https://docs.godotengine.org/en/latest/tutorials/platform/consoles.html). - -## Free, open source and community-driven - -Godot is completely free and open source under the very permissive [MIT license](https://godotengine.org/license). -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 -community-driven, empowering users to help shape their engine to match their -expectations. It is supported by the [Godot Foundation](https://godot.foundation/) -not-for-profit. - -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. - -![Screenshot of a 3D scene in the Godot Engine editor](https://raw.githubusercontent.com/godotengine/godot-design/master/screenshots/editor_tps_demo_1920x1080.jpg) +Web-based platforms and consoles. ## Getting the engine -### Binary downloads - -Official binaries for the Godot editor and the export templates can be found -[on the Godot website](https://godotengine.org/download). - ### Compiling from source -[See the official docs](https://docs.godotengine.org/en/latest/contributing/development/compiling) +[See the official docs for Godot](https://docs.godotengine.org/en/latest/contributing/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). +Redot is not only an engine but an ever-growing community of users and engine +developers. The main community is located in the [Discord](https://discord.gg/eWFDjKtd6G). To get started contributing to the project, see the [contributing guide](CONTRIBUTING.md). This document also includes guidelines for reporting bugs. ## Documentation and demos -The official documentation is hosted on [Read the Docs](https://docs.godotengine.org). -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). +The official documentation is not yet hosted. +It is maintained by the Redot community in its own [GitHub repository](https://github.com/Redot-Engine/redot-docs). -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. +The class reference is also accessible from the Redot editor. -[![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) -[![TODOs](https://badgen.net/https/api.tickgit.com/badgen/github.com/godotengine/godot)](https://www.tickgit.com/browse?repo=github.com/godotengine/godot) +We also maintain official demos in their own [GitHub repository](https://github.com/Redot-Engine/redot-demo-projects) +as well as a list of [awesome Redot community resources](https://github.com/Redot-Engine/redot-awesome).