Clone Hero Custom Content Guide

Contents:
- [The Custom folder]
- [Supported formats]
- [Adding backgrounds]
- [Adding image highways]
- [Adding video highways]
- [Adding song-specific backgrounds, highways, and videos]
  - [Syncing song-specific videos]
- [Adding game icons]
- [Adding color profiles]
- [Creating color profiles]


-------------------
[The Custom folder]
-------------------
Every type of custom asset has its own folder within the Custom folder.

- On Windows, the location of the Custom folder depends on what mode you installed the game in:
  - Typical Install: This folder is located in Documents > Clone Hero.
  - Portable Mode: This folder is located in the PlayerData folder inside the game's install directory.
- On Linux, this folder is located in the ~/.clonehero folder.
- On Mac, this folder is located in the ~/Clone Hero folder.
- On Android, this is located in Internal Storage > Clone Hero.

-------------------
[Supported formats]
-------------------
Static backgrounds and highways:
.png, .jpg, .jpeg

Animated backgrounds:
- Windows & Mac: .mp4 (x264), .avi, .webm (VP8), .ogv, .mpeg
- Linux: .webm (VP8), .ogv

Animated highways:
.webm (VP8)

-----------
[  Note!  ]
-----------
The Rescan Custom Content button in Settings > Gameplay is currently broken. You must restart the game in order for changes in custom content to show up, it rescans automatically on startup.

--------------------
[Adding backgrounds]
--------------------
1. Open the either the Custom > Image Backgrounds or Custom > Video Backgrounds folder, depending on what you want to add.
2. Place an image or video in your folder of choice.
   - See the Supported Formats section above for supported file types.
3. Restart the game, then navigate to the bottom of Settings > Gameplay.
4. Select one of the background settings and press Up/Down to change the background.

Backgrounds can be any resolution, but for general purposes a resolution of 1920x1080 or 4K is recommended.

------------------------
[Adding image highways]
------------------------
1. Open the Custom > Highways folder.
2. Place an image in the folder.
   - See the Supported Formats section above for supported file types.
3. Restart the game, then press Start to open the profile menu.
4. Select Highway in your profile menu and press Up/Down to change the highway.

Highways can be any resolution, but 512x1024 is recommended. (The game will scale the image to this resolution at run-time if it isn't already that.)

-----------------------
[Adding video highways]
-----------------------
1. Open the Custom > Video Highways folder.
2. Create a new folder and name it whatever you want.
3. Place a vp8 .webm video in the newly-created folder and name it "highway".
4. Restart the game.
5. Optionally, edit the config.ini file that the game will have created for the highway to configure how it will be displayed in-game, then restart again.
6. Press Start to open the profile menu, then select Highway and press Up/Down to change the highway.

Video highways *must* be VP8-encoded .webm. This restriction is imposed to ensure stability and compatibility on all platforms, .mp4 doesn't work on Linux and may have performance or stability issues in-game.

--------------------------------------------------------
[Adding song-specific backgrounds, highways, and videos]
--------------------------------------------------------
1. Open the folder of a song.
2. Place an image or video in the folder and name it "background" for backgrounds, "video" for videos, or "highway" for highways.
   - See the Supported Formats section above for supported file types.
3. Rescan your songs in Settings > General, then navigate to the bottom of Settings > Gameplay.
5. Enable the "Use Song Backgrounds", "Song Videos", and/or "Song Highways" settings.

   ------------------------------
-- [Syncing song-specific videos]
   ------------------------------
   In-game:

     1. Start the song and pause.
     2. Open Song Settings.
     3. Select Video Start Time.

     This value is in milliseconds. You can use Up/Down to change it by 1 ms intervals, and Left/Right to change it by 100 ms intervals.
     A positive value will move the start time further into the video, while a negative one will delay the video.

   Via the song.ini:

     1. Open the song's song.ini file.
     2. Find the "video_start_time" field and set its value to the desired number of milliseconds.

-------------------
[Adding game icons]
-------------------
1. Open the Custom > Game Icons folder.
2. Place a 1:1 aspect ratio .png image in the folder.
3. Open the song.ini file of the song you want to add the icon to.
4. Change the "icon" field to the name of your icon, without the file extension.
5. Restart the game and it should show up on the song.

-----------------------
[Adding color profiles]
-----------------------
1. Open the Custom > Colors folder.
2. Place the profile you want to use into the folder.
4. Restart the game, then press Start to open the profile menu.
5. Select Color Profile and press Up/Down to change your selected profile.

-------------------------
[Creating color profiles]
-------------------------
In-game:

1. Open your profile's Color Profile selection and select Editor.
2. Enter a name into the New Profile field and hit the + button to create a new profile.
3. Edit its colors as desired, then exit out of the editor. (Changes are saved automatically.)
4. Select the new color profile in your profile settings.

Manually:

1. Open the Custom > Colors folder.
2. Make a copy of the DefaultColors.ini file and give it a new name.
   - !! Do not edit DefaultColors.ini directly, as the game will overwrite your changes to it!
3. Open the new file with any text editor and edit the color values to your likings.
   - You may get the values to put into each field by using any online color picker.
4. Restart the game and select the color profile in your profile settings.

See this spreadsheet for detailed information on what each color profile field means:
https://docs.google.com/spreadsheets/d/1b3eyjWoYgs4ikJzUtk0v0qyre10R-ilUTrN9oZbywHI/edit?usp=sharing