LogoLogo
  • Get Started
  • Getting Started
    • Initial Setup
    • Create Your First Game
    • API Reference
    • Build Your First World Map
    • Multiplayer Testing
    • Use Templates & Examples
    • Default Assets
  • SDK Guides
    • Assets
    • Audio & SFX
      • Audio Manager
    • Blocks & Chunks
      • Block Types
      • Block Type Registry
      • Chunks
      • Chunk Lattice
    • Camera
    • Chat & Commands
    • Entities
      • Animations
      • Block Entities
      • Colliders & Hitbox
      • Child Entities
      • Entity Controllers
        • Base Entity Controller
        • Pathfinding Entity Controller
        • Player Entity Controller
        • Simple Entity Controller
      • Entity Manager
      • Model Entities
      • Movement & Pathfinding
      • Player Controlled Entities
    • Events
    • Input & Controls
    • Lighting
      • Ambient Light
      • Light Manager
      • Point Lights
      • Spot Lights
      • Sun Light (Directional)
    • Players
      • Player Manager
    • Plugins
    • Physics
      • Colliders
      • Collision Groups
      • Debugging
      • Gravity
      • Raycasts
      • Rigid Bodies
    • User Interface
      • Overlay UI
      • Scene UIs
      • Scene UI Manager
    • Worlds
      • Map Data Format
  • Helpful Resources
    • HYTOPIA Architecture & Platform Overview
    • Useful Third-Party Tools
Powered by GitBook
On this page
  • How to use examples as templates
  • Submit examples for others
  • Next Steps
Export as PDF
  1. Getting Started

Use Templates & Examples

PreviousMultiplayer TestingNextDefault Assets

Last updated 2 months ago

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 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 examples directory of the HYTOPIA SDK, 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 directory of the SDK repository.

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 repo, add your project as a folders in the examples directory, and submit a pull request to the HYTOPIA SDK repo for our team to review.

Next Steps

SDK Guides

Learn how to use more powerful HYTOPIA SDK features.