No-Code Mod Configs

Mods can now add basic configs without having to make a code mod, with the ability to use any/most mod APIs.

Creating a Config

• Create the file MOD_FOLDER/ReMIX/Config/config.yaml in your mod.
• Add a setting.

settings:
    - id: EnableBgme            # ID you'll use to get this setting.
      type: toggle              # Types: number, text, toggle
      default: true             # Default value for setting.
      name: Enable BGME         # (Optional) Setting name to show in config.
      category: Music           # (Optional) Setting category.
      description: Description. # (Optional) Setting description.

• Add an action.

actions:
    - using: BGME.Framework.Interfaces.IBgmeApi # The full name of the API to use.
      if: EnableBgme  # (Optional) Setting that enable/disables this action.
      run: AddPath    # API function to run.
      with:           # The arguments to run it with.
        - '{ModDir}/new-bgme/script.pme'

• Remember to add a Mod Dependency on any mod whose APIs you use!
• Done 🎉! A mod config should now be available, though you might have to refresh the mod list or restart Reloaded.

Constants, Placeholders, and Formatting

You can insert constants and settings into any part of an action, besides the if condition. The syntax for it is {VariableName}. If you do, make sure to wrap the entire text with ''.

String formatting is handled by SmartFormat. Consider checking out the wiki to see all features available, such as lists.

constants:
    BGME_API: BGME.Framework.Interfaces.IBgmeApi
    RYO_API: Ryo.Interfaces.IRyoApi
    
settings:
    - id: EnableBgme
      category: Music
      name: Enable BGME
      description: A description of this setting.
      type: toggle
      default: true
      
    - id: NumberSetting
      category: Category 1
      type: number
      default: 123

actions:
    - using: '{BGME_API}'
      if: EnableBgme
      run: AddPath
      with:
        - '{ModDir}/new-bgme/{NumberSetting}.pme'
        
    - using: '{RYO_API}'
      if: EnableBgme
      run: AddAudioPath
      with:
        - '{ModDir}/new-ryo/'
        - null

The File System (Creating, Deleting, Copying Files and Folders)

ReMIX Toolkit includes an API for easy access to the File System in your config.

RemixToolkit.Interfaces.IFileSystem

void CopyFile(string sourceFile, string destFile);

void CopyFolder(string sourceDir, string destDir);

void CreateFolder(string dir);

void DeleteFile(string file);

void DeleteFolder(string dir);

bool FileExists(string file);

bool FolderExists(string dir);

string ReadFile(string file);

void WriteFile(string file, string content);

Example

constants:
    FS_API: RemixToolkit.Interfaces.IFileSystem
    BATTLE_THEMES_API: BGME.BattleThemes.Interfaces.IBattleThemesApi
    
settings:
    - id: MassDestruction
      type: bool
      name: Mass Destruction
      list: NormalSongs
      value_on: p3r_MassDestructionfesReload
      default: true
      
    - id: ReachOutToTheTruth
      type: bool
      name: Reach Out to the Truth 
      list: NormalSongs
      value_on: p4_ReachOutToTheTruth
      default: true
      
    - id: LastSurprise
      type: bool
      name: Last Surprise
      list: NormalSongs
      value_on: p5_LastSurprise
      default: true

actions:
    - using: '{FS_API}'
      run: WriteFile
      with:
        - '{ModFolder}/codeless_themes/output.theme.pme'
        - |
          const songs = [{NormalSongs:list:{}|, }]
          
          const BATTLE_THEME = random_song(songs)
          
    - using: '{BATTLE_THEMES_API}'
      run: AddPath
      with:
        - '{ModId}'
        - '{ModFolder}/codeless_themes/output.theme.pme'