-
Notifications
You must be signed in to change notification settings - Fork 61
FAQ
Q: The default crashes when I run it.
A: Retrace your step and make sure you followed the guide to a T. First of all, did you read all the comments in the main file? If no, do that first. Read the error message, it'll tell you where it is crashing. If you don't understand a term it's using, you'll have to google it and learn what it is.
Q: It still crashes! Something about changing my resource folder or package name?
A: Read this.
Q: What's a pom.xml?
Q: I had it running, but I deleted a bunch of code and now it crashes, how do I fix it?
A: If you didn't follow the tutorial step by step its hard for us to help you. If you're now starting to deviate from the default in order to progress with your own mod, you can try to work out the error yourself. If you just booted up the default for the first time and decided to delete everything, I recommend you start over again from scratch and follow the tutorial (you can still try to learn and work the error out too of course).
If you've setup a version control system and made a commit before you deleted/moved things, you can reset back to that commit. As to how to do that - google is your friend.
Q: The version I downloaded seems to be different then the one people mention when I ask for help?
A: Make sure you are on the master branch and downloaded the repository as a zip.
Q: How do I do ___?
A: Look at examples in the default. If none exist, look at other mods that do something similar to what you want to do. Also, check if it's already done in BaseMod, StSLib, or the basegame (look here and then here).
Example: "How do I make a card play another card?" Look at havoc. "How do I increase max hp?" Look at the max hp relics. "How do I give a monster temporary HP?" Look at StSLib and any of the other mods that have done that, such as hubris, bard, etc.
Once you've taken a look and couldn't find what you need, feel free to come over to the modding discord channel and ask. I recommend phrasing your question like this: "I'm new to modding and got the default to run. I want to make ___ happen in my mod. Does anyone know any mods that do something similar to that and/or a github link that I should take a look at?"
Q: What is a patch? Do I need them? How do I do them?
A: Patches are a way to insert your code into the basegame. When you're starting out, chances are you won't really need them. See the Default Insrt patch in the patches package, as well as the official spirepatch documentation for when you decide that you need to learn and use them.