mirror of
https://github.com/godotengine/godot.git
synced 2024-11-25 13:43:15 +00:00
f571d1f9c1
`Godot` workflow is long removed in `master`, and is only found in the `3.2-android-app-bundle` branch currently. As of now Github actions has no way to show `passing` if all checks are passed but only to show the badge of each workflow individually. We can make a feature request later on but for now, we should remove the `Godot CI` badge as it reflects completely something else.
79 lines
3.7 KiB
Markdown
79 lines
3.7 KiB
Markdown
# Godot Engine
|
|
|
|
<p align="center">
|
|
<a href="https://godotengine.org">
|
|
<img src="logo.svg" width="400" alt="Godot Engine logo">
|
|
</a>
|
|
</p>
|
|
|
|
## 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, so that users can focus on making games
|
|
without having to reinvent the wheel. Games can be exported in 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).
|
|
|
|
## Free, open source and community-driven
|
|
|
|
Godot is completely free and open source under the very permissive MIT 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 [Software Freedom Conservancy](https://sfconservancy.org/)
|
|
not-for-profit.
|
|
|
|
Before being open sourced in February 2014, Godot had been developed by Juan
|
|
Linietsky and Ariel Manzur (both still maintaining the project) for several
|
|
years as an in-house engine, used to publish several work-for-hire titles.
|
|
|
|
|
|
|
|
## Getting the engine
|
|
|
|
### Binary downloads
|
|
|
|
Official binaries for the Godot editor and the export templates can be found
|
|
[on the homepage](https://godotengine.org/download).
|
|
|
|
### Compiling from source
|
|
|
|
[See the official 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).
|
|
|
|
To get in touch with the engine developers, the best way is to join the
|
|
[#godotengine-devel IRC channel](https://webchat.freenode.net/?channels=godotengine-devel)
|
|
on Freenode.
|
|
|
|
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).
|
|
|
|
The [class reference](https://docs.godotengine.org/en/latest/classes/)
|
|
is also accessible from the Godot editor.
|
|
|
|
The official demos are maintained in their own [GitHub repository](https://github.com/godotengine/godot-demo-projects)
|
|
as well.
|
|
|
|
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://lgtm.com/projects/g/godotengine/godot/alerts)
|
|
[](https://www.tickgit.com/browse?repo=github.com/godotengine/godot)
|