This is not the main branch!
However it will be merged eventually.

SRB2ModCompiler v2

A python script that enhances your SRB2 modding workflow!

Why is this helpful?

• Most importantly, it automates the process of saving your mod's assets into a pk3, opening the game and loading your mod every time you want to test it
• While compressed files can be uploaded to git, you can't keep track of development reliably
• Having your mod outside of a compressed file also allows mods to be edited more comfortably with apps other than SLADE. I personally recommend VS Code, since it can run this script and edit your lua files.

TL;DR:

This is tool is meant to make writing and testing code more convenient. With that said, you'll still probably rely on SLADE for graphics/sprite editing.

---

How do I download the script from GitHub?

View -> Raw -> Right Click -> Save as file

---

I ran the script, but I'm lost. How do I set this up?

• Run the script with Python or Visual Studio Code, a terminal should open
• (Skip if your mod's assets are not zipped) Use the unzip command
• (Skip if you use the mod command) Move the script to the mod's assets, it should look something like this
• (Skip if your SRB2 is in flatpak) If you haven't yet, tell it where your SRB2.exe is with the set command

You're done! Now, every time you simply press enter on the script's terminal (or when you run the simple version), this script will automatically "compile" your mod and launch your game with it

---

What do you mean it "compiles" my mod? Is it customizable?

• It makes a pk3 file containing the contents (excluding some files, such as git files and itself) of the directory the script is located at (it will also use that to determine the name of the file).

By default, this newly made pk3 is made in DOWNLOAD, but it can be changed with the downloads command

• Opens your SRB2 executable
• Skips the intro
• Loads your mod (with custom parameters if you've used the args command)
• And wishes you a happy testing session!

Contributing

Contributions are welcome! Please submit a pull request or open an issue for any suggestions or improvements.