2580d2da68
P.S: Do we use AppVeyor anymore? There hasn't been a run since two days neither do I see it in any build statuses. If not, we might remove it from `README.md`. Correct me if I'm wrong.
75 lines
3.9 KiB
Markdown
75 lines
3.9 KiB
Markdown
[](https://godotengine.org)
|
|
|
|
## Godot Engine
|
|
|
|
Homepage: https://godotengine.org
|
|
|
|
#### 2D and 3D cross-platform game engine
|
|
|
|
Godot 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, 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, Mac OSX, Windows) as well as mobile
|
|
(Android, iOS) and web-based (HTML5) platforms.
|
|
|
|
#### 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
|
|
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 developers, the best way is to join the
|
|
[#godotengine IRC channel](https://webchat.freenode.net/?channels=godotengine)
|
|
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 within the engine.
|
|
|
|
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 provided by the community,
|
|
such as text and video tutorials, demos, etc. Consult the [community channels](https://godotengine.org/community)
|
|
for more info.
|
|
|
|
[](https://travis-ci.org/godotengine/godot)
|
|
[](https://github.com/godotengine/godot/actions)
|
|
[](https://ci.appveyor.com/project/akien-mga/godot)
|
|
[](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)
|