Installing

For C# Solution

As .csproj

Go to the latest release, download the source code, and place it in your project folder. Add SUCC.csproj to your solution.

As .dll

Go to the latest release, download SUCC.dll and SUCC.xml, and place them wherever you keep your dlls. Add SUCC.dll as an assembly reference in your solution.

As Submodule

SUCC works well as a git submodule. Add SUCC as a submodule to your repository, then add SUCC.csproj to your solution.

For Unity

There are separate SUCC branches which contain a few features specific to the Unity game engine. See Version Differences for details. Please note that SUCC only officially supports Unity 2018.3+, and you must use .NET 4.x - .NET Standard 2.0 is not supported.

Note that the .unitypackage is currently the only supported way of installing the latest stable release. The other methods will install the latest commit, which can often be buggy.

As .unitypackage

Go to the latest release, download SUCC.unitypackage, and import it to Unity using Assets -> Import Package -> Custom Package. You can also double click on the .unitypackage file with Unity open.

As Unity Package

SUCC supports the Unity Package Manager.

The annoying way

1. Open the file Your Unity Project/Packages/manifest.json
2. Add the following line to the "dependencies" array: "com.jimmycushnie.succ": "https://github.com/JimmyCushnie/SUCC.git#unity",. Make sure you do NOT have a comma at the end of the line if it is the last entry in the list. Unlike SUCC, json is quite picky about file formatting.
3. open Unity and let it download the package.

The easy way (only works in 2019.3+)

1. Open the package manager window
2. Click the + button in the top left and select "Add package from git URL"
3. Paste https://github.com/JimmyCushnie/SUCC.git#unity into the text box and click "add"

If SUCC was installed successfully, you will see it in the list of packages when you open the package manager window in the Unity editor.

As Submodule

Add SUCC as a submodule to your repository. The location of the submodule should be in your project's Assets folder. Make sure to use the unity branch.