Giter Site home page Giter Site logo

ggj-template's Introduction

Unity Template for Global Game Jam

This project template follows the tutorials from GameCI using the simple example (one platform) and a Personal License. The releases are in the format required to make GGJ submissions. Namely, the zip contains:

  • Source files moved from PROJECTNAME/ to src/
  • Build in release/
  • press/ & other/ directories
  • License is CC0

How to use

  1. Fork this repo
  2. Rename GGJ-Game/ to the name of your game (no spaces)
  3. Change PROJECT_NAME from "GGJ-Game" to the same name you gave the folder
  4. Optionally, edit the target branch if you use anything other than master as your default branch (I guess main)

TODO: Explore OpenUPM

Activate License

You also need to activate a Unity license once to use the build/release job. Go to Github > <Your repository> > Actions > Acquire activation file (One time per repo) and run this workflow. Once it's done, follow these steps:

Copied from https://game.ci/docs/github/activation

  • Download the manual activation file that now appeared as an artifact.
  • Visit license.unity3d.com and upload it.
  • You should now receive your license file (Unity_v20XX.x.ulf) as a download.
  • Open Github > <Your repository> > Settings > Secrets.
  • Create a secret called UNITY_LICENSE and copy the contents your license file into it.

press directory

You'll want to push at least 1 screenshot to the press/ directory. Use press/Videos.md to link to videos uploaded somewhere.

other directory

Push other required licenses to the other/ directory and use other/Credits.md to list team members and optionally contact info.

Limitations

  1. To use GameCI for Unity version > 2019.2, this template uses GameCI actions that are still in alpha. This is probably why Test and Build steps build a new Docker image every time...
  2. Test step takes forever even with 0 tests! So it's commented out. This is probably due to it downloading assets, which should probably be done in a previous step.
  3. Due to the long duration of the main workflow you probably don't want to run this in PR, so it only runs on push/merge to master.

ggj-template's People

Contributors

devilpepper avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.