Using Templates & Examples

One of the best ways to learn is by example, or maybe there's a type of game you already know you'd like to build but you don't want to start from scratch. This is exactly what HYTOPIA templates & examples are for!

A template can be created from any example project in the HYTOPIA SDK Examples repo, found here. The available examples are constantly changing, so be sure to check often!

How to use examples as templates

To start a new HYTOPIA project based on an example in the HYTOPIA SDK Exampels repo, you can use the hytopia init command with the --template flag.

For example, if we wanted to create a new project using the wall-dodge-game example as our template, we can run:

bunx hytopia init --template=wall-dodge-game

The value used for --template can be any example project folder found in the examples repo for the SDK.

Submit examples for others

If you've created an interesting project with the HYTOPIA SDK that you'd like to be made available as an official example in the SDK repo, you can fork the HYTOPIA SDK Examples repo, add your project as a folders in the examples directory, and submit a pull request to the HYTOPIA SDK Examples repo for our team to review.

Next Steps

SDK Guides

Learn how to use more powerful HYTOPIA SDK features.