Skip to content

1. Project Configuration

Jump to bottom
Raphaël Tétreault edited this page Oct 24, 2025 · 13 revisions

Purpose

This Wiki is meant to provide key information about how to properly create a mini game for the collection. Importantly, it describes the proper workflow to apply to this project. Pull Requests that do not follow the details outline here will be rejected.

Overview

This project is set up to use Unity 2022.3.62f2. It uses the 2D Universal Render Pipeline (URP).

Restrictions

Teams are not permitted to modify any shared assets or project settings in this project. The reason being that everyone is dependent on these assets and settings, and changing them to suit your need does not mean they will suit the need of others. You are welcome to make your case as an issue on this project, but it should be assumed that you must conform to it and not vice-versa.

Teams are of course permitted to manage the code and prefabs added to their project, and manage their assets (contingent on their asset budget, see below).

Pull Request Branch

This project uses branch protection to prevent anyone from merging any old commit willy-nilly into the main branch. Once you have forked the repository and created you project on one of your fork's branches, you can create a Pull Request on your repository's main page into the source project. Target the development2025 branch to request it be merged into when you do so.

Asset Budget

You are constrained to the use of the asset packages supplied in the repository.

Teams are given a 250 KB (250,000 bytes) asset budget if deemed necessary for your mini game. Your Pull Request must both include and outline those assets when merging in your mini game. Anything beyond the allotment must receive explicit approval from your manager. Failure to comply will result in a rejected Pull Request.

See 2. Organization, Naming Conventions, and Content Rules for more details.

Provided Assets

Asset packages provided in the mini game collection include:

Provided Unity Packages

You are constrained to the use of the Unity packages supplied in the repository.

Notable Unity packages included are:

  • 2D Sprite
  • 2D Tilemap
  • 2D Tilemap Extras
  • TextMeshPro
  • Timeline

See Assets/Packages for a complete listing of packages.

Clone this wiki locally