slothsoft / unity
Slothsoft's Unity API
2.12.3
2024-07-01 12:54 UTC
Requires
- php: >=7.4
- mintopia/vdfkeyvalue: ~1.0
- mustangostang/spyc: 0.6.2
- slothsoft/core: ^1.10
- slothsoft/farah: ^1.9
- symfony/filesystem: ^5.0
- symfony/process: ^5.0
Requires (Dev)
- phpunit/phpunit: 8.5.*
- dev-master
- dev-develop / 2.12.x-dev
- 2.12.3
- 2.12.2
- 2.12.1
- 2.12.0
- 2.11.2
- 2.11.1
- 2.11.0
- 2.10.0
- 2.9.3
- 2.9.2
- 2.9.1
- 2.9.0
- 2.8.2
- 2.8.1
- 2.8.0
- 2.7.1
- 2.7.0
- 2.6.4
- 2.6.3
- 2.6.2
- 2.6.1
- 2.6.0
- 2.5.10
- 2.5.9
- 2.5.8
- 2.5.7
- 2.5.6
- 2.5.5
- 2.5.4
- 2.5.3
- 2.5.2
- 2.5.1
- 2.5.0
- 2.4.7
- 2.4.6
- 2.4.5
- 2.4.4
- 2.4.3
- 2.4.2
- 2.4.1
- 2.4.0
- 2.3.5
- 2.3.4
- 2.3.3
- 2.3.2
- 2.3.1
- 2.3.0
- 2.2.2
- 2.2.1
- 2.2.0
- 2.1.2
- 2.1.1
- 2.1.0
- 2.0.0
- 1.2.8
- 1.2.7
- 1.2.6
- 1.2.5
- 1.2.4
- 1.2.3
- 1.2.2
- 1.2.1
- 1.2.0
- 1.1.0
- 1.0.0
This package is auto-updated.
Last update: 2024-07-01 12:54:51 UTC
README
Farah Module: Unity Stuff
An API for common Unity problems.
CLI interface
All commands are executed via Composer's exec.
autoversion
> composer exec autoversion
Determine the version of a repository based on its tags and commits.
Usage:
composer exec autoversion plastic|git "path/to/repository"
steam-buildfile
> composer exec steam-buildfile
Create a steam build file.
Usage:
composer exec steam-buildfile "path/to/root" "path/to/logs" AppID [DepotID=path/to/depot]+ [SetLive]
unity-build
> composer exec unity-build
Run all tests inside a Unity project.
Usage:
composer exec unity-build "path/to/project" ["path/to/build"] [Platform]
unity-documentation
Create a documentation template for DocFX. The template will be created in a ".Documentation" folder in the project root and can be called from there with "dotnet tool run docfx". The generated documentation will be placed in ".Documentation/html".
Usage:
composer exec unity-documentation "path/to/project" [template=default+mermaid]
Supported templates:
- default
- default+mermaid
- unity
- singulinkfx+mermaid
unity-help
Shortcut for calling "unityhub help". Can be used to verify that your Unity Hub installation was succesully located.
Usage:
composer exec unity-help
unity-method
Run a specific method inside a Unity project.
Usage:
composer exec unity-method "path/to/project" "Method.To.Execute" ["additional params", ...]
unity-module-install
Install modules for use in a Unity project. Check for available modules by using the "unity-help" command.
Usage:
composer exec unity-module-install "path/to/project" [module-id]+
unity-package-install
Create a new Unity project and install a local package into it.
Usage:
composer exec unity-package-install "path/to/project/Packages/path-to-package" "path/to/new-project"
unity-project-setting
Get one of the project settings of a Unity project.
Usage:
composer exec unity-project-setting "path/to/project" "setting-name"
unity-project-version
Get or set the projectVersion of a Unity project.
Usage:
composer exec unity-project-version "path/to/project" get|set ["new-version"]
unity-tests
Run all tests inside a Unity project.
Usage:
composer exec unity-tests "path/to/project" [EditMode|PlayMode|Platform]+
Unity Accelerator
In order to use a Unity Accelerator, set the environment variable "UNITY_ACCELERATOR_ENDPOINT" to an "ip:port".