An API allowing starbound mods to be configured.
Sorry to stop half way through. Modding starbound is the kind of thing I would unironically recommend to a masochist, and then the masochist would do it because they wanted to kill themselves, not because they enjoy the pain. Feel free to fork and continue yourself, but I'm throwing in the towel.
See the branches of this repo for components.
- API Component: CLICK HERE
- Root Systems Component: CLICK HERE
- GUI Component: CLICK HERE
- CLICK HERE to see detailed documentation on how to employ XModConfig in your mod.
A new API is in progress. You can track its progress here: https://github.com/XanTheDragon/XModConfig/projects/1
- https://steamcommunity.com/sharedfiles/filedetails/?id=1998921194
- steam://url/CommunityFilePage/1998921194
You already go through enough crap when it comes to making Starbound mods work. I've got no interest in making that job any harder. It's (ideally) got good enough documentation to make the process of learning to use + implementing this API easy Please do not hesitate to create an issue requesting better documentation if confusion or difficulty arises!
Implementing configs into your mods is as easy as writing a simple patch file, and writing code to handle known config values. The code does the rest of the work for you. All you need to worry about is handling config flags in your code. You can get a template of the patch file HERE (click here)
Unsafe Lua is incredibly dangerous! It is best to treat it similarly to a firearm; never assume it is safe, and always practice extreme discretion and care when using it.
- Never enable unsafe Lua unless you have manually checked to see that none of your mods contain malicious code, and/or you are willing to risk potential catastrophic and irreversible damage to your computer should a mod employ the use of malicious code. You have been warned!
For your own safety, I will not be showing how to enable this feature. Any damage caused by other mods is not my responsibility. By enabling unsafe Lua, you acknowledge the potential dangers! Although I can personally assure you this mod does not employ malicious code, you should still check yourself because this is a serious security concern for everyone. Please be safe!
Are you a private individual who works on your own mods for you and your group of friends? Disgruntled that Starbound doesn't let you reference the player from any context and use logical sides (client/server) to streamline what you can and can't reference? Me too. Enabling Unsafe Lua allows the mod to create a global config file that can be referenced from any Lua context.
- This creates
%appdata%\.StarboundModConfigs\YOUR-MOD-NAME-HERE\config.cfgon Windows - This creates
~\.StarboundModConfigs\YOUR-MOD-NAME-HERE\config.cfgon Unix and OS-X.
For more information, check out the docs at https://github.com/XanTheDragon/XModConfig/wiki