search

Gremious / StS-DefaultModBase

(DON'T USE THIS AND BASEMOD IF YOU'RE NEW TO MODDING) This is a minimal, over-commented, "default clean slate" for jump-starting Slay the spire mods.
MIT License
112 stars 61 forks source link

Idea: Put troubleshooting guide in wiki #32

Open bug-sniper opened 5 years ago

bug-sniper commented 5 years ago

To hopefully reduce the number of people asking how they messed up in getting code coming from the DefaultModBase, I would like to propose starting a wiki with a page about troubleshooting common problems. It can include advice on

opening up the jar with 7-Zip to make sure the json and other resources are the most current making sure the source code has no compilation problems before it's jarred *running the code through a debugger if the above don't work

bug-sniper commented 5 years ago

Also, the wiki would be the place to put explanations about multiword keywords.

You may see multiword keyword names separated by what looks like spaces in some mods. Those are actually non-breaking spaces designed to help with centering of text. The non-breaking spaces are replaced with regular spaces when you view them on the web and, by default, when you paste them into an IntelliJ editor. Regular spaces cannot be part of multiword keywords and, if you try, you will have multiple non-keyword words instead.