Skip to main content

Generate a Game

tip

Understand what UrTurn is and isn't.

Create Game​

npx @urturn/runner init my-game # generates new game files
cd my-game
npm run dev # run the game locally

File/Folder structure​

game
│   package.json # npm package specification for dependencies for your room functions (includes @urturn/runner for local development)
│
└───.github/workflows # contains important GitHub actions that create a build artifact for UrTurn to use
│
└───src
│   │   main.js # room functions (e.g. onRoomStart, onPlayerMove, etc.)
│   
└───frontend # holds all the files related to your game frontend
    │   package.json  # npm package specification for dependencies on your frontend (includes @urturn/client)
    │   ...your frontend files

GitHub Actions in .github/workflows​

tip

No GitHub Actions experience needed!

We've already done the hard work for you. When you ran npx @urturn/runner init my-game, the correct github actions were created for you.

When you push to main branch of your repo on GitHub, the actions will automatically create the correct Artifact structure on the published branch, which you will use to deploy to production.