Game Jam Template (ru)

Summary

There is a blank template for small game production for jam usage. It allows you to do not waste time on infrastructure tasks, keeps focusing on game development.

Features:

• Command-line build
• Upload to itch.io

Requirements

• Install Unity Hub into the default location
• Install any Git client (eg Fork, SourceTree, Github Desktop etc)
• Install some version of Unity Editor from Unity Hub, prefer LTS versions
• Install .NET Core SDK
• Install Nuke: dotnet tool install --global Nuke.GlobalTool --version 0.25.0
• Make sure that git and nuke commands are available in your terminal (paths to directory with executables should be added to PATH environment variable, see related articles: Windows, MacOS)
• Git repository for your project (Github, Bitbucket)
• (optional) itch.io account

Starting your project

You have three options:

• Click 'Use this template' on the page and follow instructions
• Copy all content of this repository and start working
• Copy only required files inside your existing project:
  • Assets/Scripts/Editor
  • BuildPipeline
  • .nuke
  • build.cmd
  • build.ps1
  • build.sh

After it, I suggest you to make a separated copy of your repository somewhere to operates with it without interruptions in development process (Unity don't allow you to build a project in command-line mode while it's already opened in UI editor).

Basics

To perform build actions, you need to open your terminal, navigate to your project location and run the provided commands.

Build

Pull changes & build in single command:

nuke --target BuildAfterUpdate

Pull changes only:

nuke --target Update

Build only:

nuke --target RunBuild

Change build platform (WebGL is used by default):

nuke --target RunBuild --platform StandaloneOSX

While build is started, version of your project was changed (short commit hash added at the end followed by dot, like 1.0.0.200a6a3). You can access that version via Application.version and show it somewhere in game UI.

Publish

Attention! Standalone targets for publish is not yet supported.

To upload your game you need to create it in itch.io dashboard.

For web version you need to select HTML in Kind of project.

To perform update and build before upload automatically:

nuke --target PublishAfterBuild --publishTarget TARGET

If you need to publish only:

nuke --target Publish --publishTarget TARGET

Where TARGET is a string like username/game-name:platform (for this sample it will be konh/game-jam-template:html).

When you publishing a build for the first time, you need to authorize your machine.