diff --git a/README.md b/README.md index 8a3e269..ec08451 100644 --- a/README.md +++ b/README.md @@ -1 +1,100 @@ -# unity-action \ No newline at end of file +# setup-unity + +
+ +GitHub Action to download and install Unity. Based on Unity Hub. + +Works on Ubuntu, macOS and Windows. + +## Inputs + +### `unity-version` + +Unity version to install. For example, `2019.4.9f1`. Project version will be used if not provided. + +### `unity-version-changeset` + +Unity version changeset. For example, `50fe8a171dd9`. Automatically parsed from Unity site if not provided. + +### `unity-modules` + +List of Unity modules (e.g. build support) to install. For example, `[ios, android, webgl]`. + +Available modules: + + Documentation: documentation + Standard Assets: standardassets + Example Project: example + Android Build Support: android + iOS Build Support: ios + tvOS Build Support: appletv + Linux Build Support: linux-mono + SamsungTV Build Support: samsung + Tizen Build Support: tizen + WebGL Build Support: webgl + Windows Build Support: windows + Facebook Gameroom Build Support: facebook-games + MonoDevelop / Unity Debugger: monodevelop + Vuforia Augmented Reality Support: vuforia-ar + Language packs: language-ja, language-ko, language-zh-cn, language-zh-hant, language-zh-hans + Mac Build Support (IL2CPP): mac-il2cpp + Windows Build Support (Mono): windows-mono + Android SDK & NDK Tools: android-sdk-ndk-tools + OpenJDK: android-open-jdk + Lumin OS (Magic Leap) Build Support: lumin + +Also list of available modules can be checked by execute: `