Skip to content

Latest commit

 

History

History
35 lines (20 loc) · 1.66 KB

README.md

File metadata and controls

35 lines (20 loc) · 1.66 KB

stephensons-rocket-mod

This is a template for Stephenson's Rocket mods.

To create a mod for Stephenson's rocket, you first clone the stephenson's rocket repo:

git clone --depth=1 https://github.com/steamos-community/stephensons-rocket.git

After you've done that move into the newly created repo and clone this repo like this:

cd stephensons-rocket
git clone https://github.com/steamos-community/stephensons-rocket-mod.git

Now you can start working on your mod. It can be found in stephensons-rocket/stephensons-rocket-mod/ by default, but feel free to rename the directory to better reflect it's function. New packages are placed in the directory packages and are installed when placed behind install= in the config file. Packages behind remove= in the config file will be removed from the pool before installing your mod.

You can download new packages or update existing packages in your mod with the downloadpackages.sh script. Which uses the repositories found in the sources.list file. To download packages you can run:

./downloadpackages.sh update
./downloadpackages.sh download package1 package2 package3

Just keep in mind that if you forget to download a dependency, your package will not install.

You can download the latest version of all packages in the packages directory with:

./downloadpackages.sh update
./downloadpackages.sh upgrade

Using your own post_install.sh script is also possible, just put your version in your mod directory.

Make sure all the repos you used to download packages can be found in the sources.list file of your mod.

If you want to generate an iso with your mod, just run:

./gen.sh yourmod

That's it, good luck!