Skip to content

A collection of utility and GUI functions to kickstart Spin Rhythm XD mods

License

Notifications You must be signed in to change notification settings

Raoul1808/SpinCore

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

76 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

SpinCore

Library and utility mod for Spin Rhythm XD.

Features

  • Custom panels and nested mod settings pages
  • Custom UI components on tabs and pages
  • Custom UI components on modal dialogs
  • Tooltips on custom UI components (only in options menu)
  • Translations
  • Custom chart triggers
  • A collection of utility functions

How to use

In your mod, add a reference to the mod (SpinCore.dll) and add a dependency to SpinCore to your mod like so:

+using SpinCore;
 ...

 [BepInPlugin("srxd.johndoe.mycoolplugin", "My Cool Plugin", "0.1.0"]
+[BepInDependency(SpinCorePlugin.Guid, SpinCorePlugin.Version)]
 internal class MyCoolPlugin : BaseUnityPlugin
 ...

This line will make sure the mod loads only if SpinCore is loaded with the given version string.

If your mod has optional SpinCore support, you will need to manually enter the guid (?) and declare your plugin a soft dependency.

From there on, you can start using SpinCore in your mod. If you need a reference on how to use the mod, check out this repo's TestMod.

License

This mod is licensed under the MIT License.

About

A collection of utility and GUI functions to kickstart Spin Rhythm XD mods

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages