diff --git a/README.md b/README.md index fd71883..195fd6a 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ - [Overview](#overview) - [Requirements](#requirements) -- [Usage](#usage) +- [Usages](#usages) - [Supported Platforms](#supported-platforms) -- [Known Supported Unity Versions](#known-supported-unity-versions) +- [Supported Unity Versions](#supported-unity-versions) - [Todo List](#todo-list) - [Credits](#credits) - [License](#license) @@ -17,35 +17,57 @@ The Unity Splash Screen Remover is a Command-Line Interface (CLI) tool designed to remove the Unity splash screen logo from Unity-built games. -The tool is an implementation of the guide available at [https://github.com/kiraio-moe/remove-unity-splash-screen](https://github.com/kiraio-moe/remove-unity-splash-screen). By utilizing this tool, you can easily remove Unity splash screen logo from your games and keep your own logo displayed. +The tool is an implementation of the guide available at . By utilizing this tool, you can easily remove Unity splash screen logo from your games and keep your own logo displayed. ## Requirements - [.NET 6.0 SDK](https://dotnet.microsoft.com/download/dotnet/6.0 ".NET 6.0 SDK") or [.NET 7.0 SDK](https://dotnet.microsoft.com/download/dotnet/7.0 ".NET 7.0 SDK") -## Usage +## Usages To use the tool, follow the steps below: -1. Download the Unity Splash Screen Remover from [Releases](https://github.com/kiraio-moe/USSR/releases) page. -2. Drag and drop your game executable to `USSR.exe` or execute USSR as follow: +1. Download USSR from [Releases](https://github.com/kiraio-moe/USSR/releases) page. +2. There's many ways to use USSR. Choose which one you feel most comfortable with. - ```bash - USSR.exe - ``` + - Drag and drop your game executable `(*.exe|*.x86|*.dmg|index.html)` to `USSR.exe`. + - Drag and drop `globalgamemanagers` or `data.unity3d` file (_`WebGL.data` currently not supported_) to `USSR.exe`. + - Execute USSR on CLI: -## Supported Platforms + ```bash + USSR.exe + ``` + +3. For Android platform, there's extra work for it. You doesn't need **Decompile** and **Recompile** process as done in the [guide](https://github.com/kiraio-moe/remove-unity-splash-screen "remove-unity-splash-screen guide"). + + - Make sure you already have [`JDK`](https://www.openlogic.com/openjdk-downloads?field_java_parent_version_target_id=416&field_operating_system_target_id=All&field_architecture_target_id=All&field_java_package_target_id=All "OpenJDK") & [`SDK`](https://androidsdkoffline.blogspot.com/p/all-android-sdk-latest-stable-versions.html) installed. In another word, you can build your game in Unity Editor. + - [Android Studio](https://developer.android.com/studio "Android Studio") installed. Make sure to set the `JDK` and `SDK` path to the one you used for Unity Editor. + - Follow these steps: + + - **Check** `Export Project` in `Build Settings` when you want to build. + - After it has been exported, **remove** the splash screen by drag & drop `globalgamemanagers` or `data.unity3d` file in `/unityLibrary/src/main/assets/bin/Data/` or from CLI: -Unity Splash Screen Remover currently supports the following platforms: + ```bash + USSR.exe /unityLibrary/src/main/assets/bin/Data/(globalgamemanagers|data.unity3d)> + ``` + + - **Remove** the backup file (`*.bak`) generated by USSR or **move** to somewhere else outside of ``. + + - After successfully removing the splash screen, **import** the project to `Android Studio`. + - **Build** the project. + - If you want to upload your game to app store (e.g. Google Play Store), you can `sign` your game with `keystore` and build the project as app bundle (`.aar`). I won't cover those steps here because you can find them pretty much on the internet. + +## Supported Platforms -- PC, Mac, Linux Standalone (Support LZ4 & LZ4HC compression) -- WebGL (Support Brotli & GZip compression) +USSR support the following platforms: -## Known Supported Unity Versions +- PC, Mac, Linux Standalone (Support Default, LZ4 & LZ4HC compression) +- Android (Support Default, LZ4 & LZ4HC compression) +- WebGL (Support Default, Brotli & GZip compression) -- 2019 ~ 2022 +## Supported Unity Versions -For other versions, please test it yourself and let me know! +- Unity 5 ~ Unity 2023 ## Todo List @@ -55,8 +77,8 @@ For other versions, please test it yourself and let me know! - ~~Support Brotli compression~~ ✔️ - ~~Support GZip compression~~ ✔️ - ~~Support compressed build~~ ✔️ -- Refactor code -- Add support for Android +- ~~Add support for Android~~ ✔️ +- Refactor code 🚧 ## Credits