pandemonium_demo_projects/README.md

56 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

# Godot demo projects
Each folder containing a `project.godot` file is a demo project meant to
be used with [Godot Engine](https://godotengine.org), the open source
2D and 3D game engine.
## Godot versions
- The [`master`](https://github.com/godotengine/godot-demo-projects) branch is compatible with Godot's `3.x` branch.
- The [`4.0-dev`](https://github.com/godotengine/godot-demo-projects/tree/4.0-dev) branch is compatible with Godot's `master` branch (currently 4.0-beta).
- If you are using an older version of Godot, use the appropriate branch for your Godot version:
- [`3.4`](https://github.com/godotengine/godot-demo-projects/tree/3.4)
branch for Godot 3.4.x.
- [`3.3`](https://github.com/godotengine/godot-demo-projects/tree/3.3)
branch for Godot 3.3.x.
- [`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
- [Main website](https://godotengine.org)
- [Source code](https://github.com/godotengine/godot)
- [Documentation](http://docs.godotengine.org)
- [Community hub](https://godotengine.org/community)
- [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.