UnityQuickStartCli is a command-line interface (CLI) tool designed to automate the setup and creation of Unity projects, as well as local and remote Git repositories. It streamlines the process of initializing a new Unity project, setting up Git repositories, and configuring project settings. In a nutshell this is a wrapper for the Unity & Github Cli's
- Unity Project Creation: Automatically sets up a new Unity project.
- Git Integration: Initializes local and remote Git repositories.
- Customizable Settings: Allows you to set Unity installation paths and versions.
- User-Friendly Interface: Provides a clean and straightforward CLI.
To run this project, you'll need the following software installed:
- .NET SDK: Download and install from here.
- GitHub CLI: Follow the installation guide here.
- Unity: Download and install Unity Hub from here.
- Download the latest NuGet package from the releases page.
- To install the tool globally replacing with the path to the directory containing the NuGet package.
Note do not set the path directly to the NuGet package!
dotnet tool install --global --add-source <path> UnityQuickStart
To uninstall the tool:
dotnet tool uninstall --global UnityQuickStart
- Open the project in Rider.
- Run
dotnet pack
to package the application. - Follow the global installation steps above to install the tool.
Run the CLI tool with the following command:
unityquick [options]
--help
: Show the help page.--version
: Log the UnityQuickStartCli version.-c, --clear
: Resets the settings to default.-p, --path
: Set the Unity installation path.
unityquick -p "C:\Program Files\Unity\Hub\Editor"
WindowsTerminal_wvpt3Op1kb.mp4
Git.cs
: Handles Git-related functionalities.UnityCli.cs
: Manages Unity project creation and settings.QuickStartProject.cs
: Represents the Unity project.UserSettings.cs
: Manages user settings like Unity paths and versions.
// Contribution guidelines to come
This project is licensed under the MIT License.
Copyright (c) 2023 Nonatomic Ltd