Skip to content
This repository has been archived by the owner on Mar 14, 2024. It is now read-only.
/ SRB2-compiler Public archive

A python program to automate the proccess of making SRB2 mods fit for git. Currently in an unfinished state

Notifications You must be signed in to change notification settings

felixLumyni/SRB2-compiler

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 

Repository files navigation

PLEASE DON'T USE THIS, IT'S DEPRECATED

SRB2Compiler has been updated to V2!

It's simpler to use and way more optimized \o/

Old README

SRB2-Compiler

A python program to automate the proccess of making SRB2 mods fit for git.

Download with DownGit

Download compatibility version with DownGit

Why is this helpful?

  • While compressed files - such as ZIP/WAD/PK3 - can be uploaded with git, you can't keep track of development (like which files were added, removed or modified in each commit/version)
  • Having your mod outside of a compressed file also allows mods to be edited more easily with apps other than SLADE
  • The compiler tool can automate the process of saving your mod to a PK3 every time you want to test the mod
  • The decompiler tool can automate the process of exporting your PK3 mod to a folder so it can be versioned with git
  • Your settings are saved automatically based on the file name. You can also expand the window vertically in the Compiler menu to save and load custom presets

How to use this to build and test your mod

  • Open the .py file with Python
  • Compiler settings page: Specify which folder will be converted into a pk3
  • Compiler settings page: Specify where your 7-Zip is installed
  • (OPTIONAL) Compiler settings page: Specify the preferred filename for the pk3
  • (OPTIONAL) Compiler settings page: Specify where the pk3 will be moved to afterwards (By default, it goes to wherever the compiler is)
  • (OPTIONAL) Compiler settings page: Specify a .bat to automatically launch SRB2 with your mod after compiling (Example: srb2win.exe -debug -opengl -warp 1 -file MyCoolMod.pk3 +weather 1)
  • Compiler page: Compile and/or test the mod

How to use this to export your PK3 mod

  • Open the .py file with Python
  • Decompiler settings page: Specify where your 7-Zip is installed
  • Decompiler settings page: Specify which PK3 will be cloned to a folder
  • Decompiler page: Decompile your mod, and sort files to remove duplicate files so it can be ran in SRB2 after compiling (WORK IN PROGRESS)

About

A python program to automate the proccess of making SRB2 mods fit for git. Currently in an unfinished state

Topics

Resources

Stars

Watchers

Forks

Languages