Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Voltstro-Studios/UnityCommandLineParser
Simple command line argument parser for Unity
https://github.com/Voltstro-Studios/UnityCommandLineParser
commandlineparser csharp unity unity-package unity-script unity-scripts unity2d unity3d
Last synced: 3 months ago
JSON representation
Simple command line argument parser for Unity
- Host: GitHub
- URL: https://github.com/Voltstro-Studios/UnityCommandLineParser
- Owner: Voltstro-Studios
- License: mit
- Created: 2020-09-12T13:19:45.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-08-12T10:11:32.000Z (over 2 years ago)
- Last Synced: 2024-01-28T23:11:52.611Z (10 months ago)
- Topics: commandlineparser, csharp, unity, unity-package, unity-script, unity-scripts, unity2d, unity3d
- Language: C#
- Homepage:
- Size: 202 KB
- Stars: 34
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# UnityCommandLineParser
[](/LICENSE)
[](https://discord.voltstro.dev)
[](https://www.youtube.com/Voltstro)
A command line parser for Unity.
One of the issues that plague most C# command line parsers is that they are designed to be run from `Program.Main(string[] args);` and basically take over as the entry point of your C# app. However, Unity doesn't have the standard C# entry point. So we created this project, a command line parser for Unity that is easy to use.
This project uses [McMaster.Extensions.CommandLineUtils](https://github.com/natemcmaster/CommandLineUtils) as its underlying parsing library and provides attributes to mark fields that can be filled out by an argument. You can use any field type that [CommandLineUtils](https://github.com/natemcmaster/CommandLineUtils/blob/main/src/CommandLineUtils/Abstractions/ValueParserProvider.cs) supports by default.
## Features
- Parses launch arguments when the player is launched.
- Supports commands and arguments
## Getting Started
### Package Installation
#### Prerequisites
```
Unity 2020.3.x
```
### Installation Methods
There are three main sources on how you can install this package. Pick which ever one suites you the best!
#### Voltstro UPM
You can install this package from our custom UPM registry. To setup our registry, see [here](https://github.com/Voltstro/VoltstroUPM#setup).
Once you have the registry added to your project, you can install it like any other package via the package manager.
#### OpenUPM
You can install this package via [OpenUPM](https://openupm.com/).
To install it, use their CLI:
```bash
openupm-cli add dev.voltstro.unitycommandlineparser
```
#### Git
To install it via the package manager with git you will need to:
1. Setup [UnityNuGet](https://github.com/xoofx/UnityNuGet#unitynuget-)
2. Open up the package manager via Windows **->** Package Manager
3. Click on the little + sign **->** Add package from git URL...
4. Type `https://github.com/Voltstro-Studios/UnityCommandLineParser.git` and add it
5. Unity will now download and install the package
Please note that you will have to manually check for updates, and replace the hash (or tag version) in your project's `packages-lock.json` file.
### Usage
Mark a static field with a `[CommandLineArgument]` attribute to be able to be set as a command line argument.
Or you can mark a static method with a `[CommandLineCommand]` attribute to be able to run a method as a command line argument.
#### Examples
```csharp
[CommandLineArgument("name", "Sets the name of the player")]
public static string Name = "Voltstro";
[CommandLineArgument("fps", "Sets the fps of the game.")]
public static int Fps = 60;
[CommandLineCommand("weapons", "Adds all default weapons to the player on load")]
public static void AddDefaultWeapons()
{
//Do some cool stuff
}
```
If this example was to be run with the commands: `./UnityPlayer -fps 420 -name "EternalClickbait Suxs" -weapons`, it would set the `Fps` variable to `420`, set the `Name` variable to `EternalClickbait Suxs` and run the method `AddDefaultWeapons()` on startup.
## Authors
**Voltstro** - *Initial Work* - [Voltstro](https://github.com/Voltstro)
## License
This project is licensed under the MIT License - see the [LICENSE.md](/LICENSE.md) file for details.