diff --git a/README.md b/README.md index e1bbae4..9dbfe28 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,9 @@ A Unity project template for creating custom visuals. ### Getting Started +- Install the SRXDCustomVisuals mod at https://github.com/SRXDModdingGroup/SRXDCustomVisuals/releases/latest +- Extract SRXDCustomVisuals.zip to your BepInEx plugins folder at + - ```C:\Program Files (x86)\Steam\steamapps\common\Spin Rhythm\BepInEx\plugins``` - Install Unity Hub and Unity version 2022.1.12 - Download the latest release of srxd.visuals.tgz - Place the file in the Unity projects template folder at @@ -12,25 +15,30 @@ A Unity project template for creating custom visuals. ### Creating a New Visual Element -- Create a new folder in the Bundles folder to contain the assets for your visual element -- Create a new folder in the Scripts folder to contain any scripts used by your visual element. Add an assembly definition to this folder +- Create a new folder in the Assets folder to contain the assets for your visual element +- In this new folder, create a Scripts folder to contain any scripts used by your visual element. Add an assembly definition to this folder and specify srxdbackgrounds.common as one of its dependencies - Create a new GameObject in your scene. Ensure that the prefab's transform is all 0 for position and rotation, and all 1 for scale - Add the VisualsEventReceiver script to your GameObject - Drag the GameObject into your new assets folder to create a prefab - After adding visuals to your prefab, press Play to enter the game view and see a preview of how the scene will appear in-game -### Building AssetBundles and Adding Them to SRXD +### Building Asset Bundles and Adding Them to SRXD - Select your prefab asset and assign an asset bundle at the bottom of the Inspector - Open the AssetBundle Browser (Window > AssetBundle Browser) and click Build -- By default, all AssetBundles will be built to +- By default, all Asset Bundles will be built to - ```/AssetBundles/StandaloneWindows``` -- Copy both the asset bundle file and manifest file for each bundle to the AssetBundles folder in your plugins folder -- Create a new .json file in the Backgrounds folder in your plugins folder. Add the following: +- Go to your BepInEx plugins folder +- Copy both the asset bundle file and manifest file for each bundle to the AssetBundles folder +- Create a new .json file in the Backgrounds folder. Add the following, filling in the appropriate bundle, assembly, and prefab names: ```json { "disableBaseBackground": true, + "useAudioSpectrum": false, + "useAudioWaveform": false, + "useDepthTexture": false, + "farClip": 100, "assetBundles": [ "", "common"