UnityQuickStartCli

Description

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

Features

• 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.

Dependencies

To run this project, you'll need the following software installed:

• .NET SDK
• GitHub CLI
• Unity

Installation Steps

1. .NET SDK: Download and install from here.
2. GitHub CLI: Follow the installation guide here.
3. Unity: Download and install Unity Hub from here.

Installation

Global Installation

1. Download the latest NuGet package from the releases page.
2. To install the tool globally replacing

Note do not set the path directly to the NuGet package!

dotnet tool install --global --add-source <path> UnityQuickStart

Uninstallation

To uninstall the tool:

dotnet tool uninstall --global UnityQuickStart

Build from Rider

1. Open the project in Rider.
2. Run dotnet pack to package the application.
3. Follow the global installation steps above to install the tool.

Usage

Run the CLI tool with the following command:

unityquick [options]

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.

Examples

unityquick -p "C:\Program Files\Unity\Hub\Editor"

https://github.com/PaulNonatomic/UnityQuickStartCli/assets/4581647/6147804f-edf1-4548-8b46-555aa074e24b

Code Structure

• 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.

Contributing

// Contribution guidelines to come

License

This project is licensed under the MIT License.

Copyright (c) 2023 Noantomic Ltd