Example Theme

This is an example repo for an external theme for my Battle Cats Save Editor

If you want to make your own theme for the editor, you can fork this repo and edit the theme.json file to your liking.

If you need help, or want any extra features, you can join the Discord server and ask in the #tool-dev channel, or make suggestions in the #suggestions channel.

How to make a theme

1. Fork this repo
2. Edit the theme.json file
3. Install git
4. In the editor, go to Edit config -> Theme -> Add Theme
5. Enter the URL of your forked repo (with the .git at the end)
6. Restart the editor to see the changes

The theme will be added into the external_themes folder in bcsfe in your documents folder. The folder name will be ext-<author>-<short_name> so that collisions with other themes are avoided.

Theme.json file

The theme.json file contains the data about the theme. Here are what the different fields mean:

• short_name: The short code for the theme. This is used in the file name and config value in the editor and so shouldn't really contain any spaces or special characters.
• name: The name of the theme. This is what will be shown in the editor to the user.
• author: The name of the author of the theme.
• version: The version of the theme. This is used to check for updates to the theme. Every time you want to release an update to the theme, you should increase this. It can be any string, but it is recommended to use semantic versioning.
• description: A description of the theme. This is shown in the editor to the user.
• colors: The colors used in the theme. These are used in the editor to color the different text. The values for the colors should be in hex format, and should be surrounded by quotes, e.g "#FFFFFF". The colors are:
  • primary: This is used for any text that doesn't have a specific color.
  • secondary: This is used for highlighting text when the text color is not primary or secondary.
  • tertiary: This is used for highlighting text when the text color is primary or secondary.
  • quaternary: This is mainly used for status text, e.g "Downloading ...", "Checking for updates ...". etc.
  • error: This is used for error messages.
  • warning: This is used for warning messages, usually if there is a ban risk or a save corruption risk.
  • success: This is used for successfully completed actions.