Guidelines to Modding

From Starsector Wiki
Jump to navigation Jump to search

Technical Guidelines you should try to follow while designing your mod.

If you’re looking for Guidelines on how you should balance your ships, look at DR’s Modding Guidelines for that.

  • When you’re adding ships/fighters/etc and stuff to your csvs, Make sure all the IDs has a prefix so people know where it is from. Avoid using simple 3 letter Prefixes thought
  • If for some reason you need to change vanilia content, Document the changes so you can clearly tell people what exactly changed. Otherwise, Don’t alter it without a good reason. Other mods rely heavily on it and you changing it could cause problems.
  • Don’t make work for other modders because something in your mod made their mods incompatible with yours. This goes back into altering vanilia content. If you want to make it compatible with other people’s mods, look into this
  • Ask permission BEFORE Reusing Assets/Code or making an Mod that expands on their mod in some way. Lack of response is a presumed negative permission.
  • Some mods have permissive licences enabling reuse. It is still good practice to talk to the author as they will often have insight or additional resources.
  • If you’re making something akin to a Meme/Joke mod, make sure to label it as such. You don’t want someone to accidentally a mod you made as joke and end up having it ruin their experience somehow.