Index Customization Project

This is a project to allow users to create and bundle custom themes, platforms, and models for the Index panel.
This README is a documentation on how to make and bundle these custom objects for Index.

Current options:
Theme Creation
Platform Creation
Custom Models [Coming Soon]

Theme Creation

Warning

You can use a custom model with a theme, but as there is no button/text repositioning, the model may look off.
The creator and contributors of this project advise you to wait for Custom Models to be part of the project as well.
Completion on custom models is [70%] complete.

To make a theme, drag and drop the Custom Theme prefab into your scene view.

Now you can edit the variables inside of the Index Custom Theme script.

After you are done adding info and setting up the materials, go to the top of your screen and select Index Customization Tools > Index Theme Packing.

Now press the button that reads the name of your theme object.

Now press the BUNDLE button and wait for it to finish.

To find your packaged theme, go to Assets/IndexThemeBundles, and find your theme. The theme file should have the extension of .indextheme.

Now whenever you're ready, copy this file into the Index/Loaders/Themes folder in your BepInEx plugins. (If this folder doesn't exist, create it, or check your Index version.)

Now when you load into your game, you should be able to activate your theme.

Platform Creation

Tip

You can use custom platform models as long as the model (in your 3d modeling software) or the gameobject (in Unity) has a scale of [0.3, 0.06, 0.3] or less, and as long as you add the Index Custom Platform script to your object.

Warning

The loader for platforms divides your platform model by [0.3, 0.06, 0.3], so make sure that your platform size is the exact same as the prefab size. (If the size of your model in your 3d modeling software matches 0.3, 0.06, 0.3, the ideal scale for your platform in the Unity editor should be 50, 50, 50)

To make a theme, drag and drop the Custom Platform prefab into your scene view.

Now you can edit the variables inside of the Index Custom Platform script.

After you are done adding info and setting up the materials, go to the top of your screen and select Index Customization Tools > Index Platform Packing.

Now press the button that reads the name of your theme object.

Now press the BUNDLE button and wait for it to finish.

To find your packaged theme, go to Assets/IndexPlatformBundles, and find your theme. The theme file should have the extension of .indexplatform.

Now whenever you're ready, copy this file into the Index/Loaders/Platforms folder in your BepInEx plugins. (If this folder doesn't exist, create it, or check your Index version.)

Now when you load into your game, you should be able to activate your theme.