create-unity-project

A GitHub Action to create a new Unity Project using a predefined template package.

How to use

Requirements

Important

This action requires that the Unity Editor is installed on the runner.

You can use unity-setup action to install Unity Editor before using this action.

• UNITY_EDITOR_PATH environment variable must be set to the path of the Unity Editor executable.

Important

This action requires an active Unity license be available on the runner.

You can use activate-unity-license action to activate the Unity license before using this action.

• A license activation for the Unity Editor must also be completed before using this action.

workflow

steps:
  - uses: RageAgainstThePixel/create-unity-project@v1
    with:
      project-name: Test Project
      project-directory: ./Unity Project
      template-name: com.unity.template.3d(-cross-platform)?

inputs

name	description	required
project-name	The name of the Unity project to create.	true
project-directory	The directory where the Unity project will be created.	Defaults to the root of the workspace.
template-name	The name of the template package to use for creating the Unity project.	Default: com.unity.template.3d(-cross-platform)?

Note

template-name supports regex patterns, allowing you to match multiple template packages. For example, com.unity.template.3d(-cross-platform)? will match both com.unity.template.3d and com.unity.template.3d-cross-platform.

outputs

• project-path: The path to the created Unity project. This is the absolute path to the project directory.