godot-demo-projects/README.md

59 lines
2.5 KiB
Markdown
Raw Permalink Normal View History

2016-06-03 17:56:10 +02:00
# Godot demo projects
2017-07-29 06:23:34 +02:00
Each folder containing a `project.godot` file is a demo project meant to
2016-06-03 17:56:10 +02:00
be used with [Godot Engine](https://godotengine.org), the open source
2D and 3D game engine.
2020-02-09 07:36:36 +01:00
## Godot versions
2016-06-03 17:56:10 +02:00
- The [`master`](https://github.com/godotengine/godot-demo-projects) branch is compatible with Godot's `master` development branch (next 4.x release).
- The [`3.x`](https://github.com/godotengine/godot-demo-projects/tree/3.x) branch is compatible with Godot's `3.x` development branch (next 3.x release).
- The other branches are compatible with the matching stable versions of Godot:
- [`4.0`](https://github.com/godotengine/godot-demo-projects/tree/4.0)
branch for Godot 4.0.x.
- [`3.5`](https://github.com/godotengine/godot-demo-projects/tree/3.5)
branch for Godot 3.5.x.
- [`3.4`](https://github.com/godotengine/godot-demo-projects/tree/3.4)
branch for Godot 3.4.x.
2021-11-05 16:13:20 +01:00
- [`3.3`](https://github.com/godotengine/godot-demo-projects/tree/3.3)
branch for Godot 3.3.x.
2021-03-30 10:16:35 +02:00
- [`3.2`](https://github.com/godotengine/godot-demo-projects/tree/3.2)
branch for Godot 3.2.x.
- [`3.1`](https://github.com/godotengine/godot-demo-projects/tree/3.1)
branch for Godot 3.1.x.
- [`3.0`](https://github.com/godotengine/godot-demo-projects/tree/3.0)
branch for Godot 3.0.x.
- [`2.1`](https://github.com/godotengine/godot-demo-projects/tree/2.1)
branch for Godot 2.1.x.
## Importing all demos
To import all demos at once in the project manager:
- Clone this repository or [download a ZIP archive](https://github.com/godotengine/godot-demo-projects/archive/master.zip).
- If you've downloaded a ZIP archive, extract it somewhere.
- Open the Godot project manager and click the **Scan** button on the right.
- Choose the path to the folder containing all demos.
- All demos should now appear in the project manager.
## Try the demos in your browser
Most of the demos are exported to GitHub Pages. They can be viewed
[here](https://godotengine.github.io/godot-demo-projects/).
**Note:** The performance of Godot in a browser is lower than natively on
desktop. For the best performance, consider downloading the demos.
## Useful links
2016-06-03 17:56:10 +02:00
- [Main website](https://godotengine.org)
- [Source code](https://github.com/godotengine/godot)
- [Documentation](http://docs.godotengine.org)
- [Community hub](https://godotengine.org/community)
2021-03-30 10:16:35 +02:00
- [TPS demo](https://github.com/godotengine/tps-demo)
## License
Those demos are distributed under the terms of the MIT license, as
described in the [LICENSE.md](LICENSE.md) file.