Scrapland Mods

This repository is a just my playground where I learn how to mod Scrapland and try to make something useful and/or fun. Don't take this repository too serous. It is no near good example on modding Scrapland. I am just playing around here 😅.

Warning: everything in here is in development!
Anything, at any time can stop work properly, crash your game, set your pc on fire, start cancer or kill your dog. Use it on your own.

Table of content

• Requirements
• build.ps1
  • Setup
  • How to use
• Mods structure
  • Simple mod
  • Mod with custom text
• Existing mods
• Useful links

Requirements

For building .packed files with build.sh I use ScrapPackedExplorer. If you want to use my build.sh you need to use ScrapPackedExplorer >= 0.3.1.

For compiling .py to .pyc you need Python 1.5.2.

And preferably you need to have any version of Scrapland itself 😄.

build.ps1

build.ps1 is a script that can build, install and uninstall mods from this repo.

Setup

To use build.ps1 you need to do 2 simple steps:

1. Copy config.example.ps1 to config.ps1
2. Change paths to ScrapPackedExplorer, Python 1.5.2 and Scrapland to yours.

$packed_explorer_path = '..\bins\spe.exe';
$pyhton_path          = 'C:\Program Files (x86)\Python\python.exe';
$scrapland_path       = 'D:\Games\SteamLibrary\steamapps\common\Scrapland';

If you will not do this 2 steps build.ps1 will use default variables.

How to use it

Building mods:

.\build.ps1          # If no argument specified will build all folders except 'bin' and 'out'
.\build.ps1 ModName  # Will build mod from folder "ModName"

Flags:

.\build.ps1 -i --install   # Installs mod after building it
.\build.ps1 -u --uninstall # Instead of building mod will uninstall it

Mods will be in the out folder

Every folder is a separate mod.

Mods structure

There is 2 types of "configuration" of mod folder: simple and with misc

Simple mod

Everything in mod folder except README.md will be packed in .packed file. That's it. Pretty simple.

Mod with custom text

..
ModFolder\
|__ packed\
|____ ...
|__ lang\
|____ ...

packed folder is your ModName.packed. Everything in it will be packed and loaded to the game's Mods folder

lang folder is where yours files with custom text lines works.
File with custom text should be named just as file in Scrapland\Languages\, i.e. English.txt, German.txt, Russan.txt etc.
It should contains only new lines that you want to add.

When mod loads script will save original text file, and it will append to it everything from all loaded mods, that have same <Language>.txt file.

Existing mods:

• Loader: Contains just scripts/init.py.
• Logger: Contains... logger. How surprising.
• Police2Gear: Replaces default money-bagging police action to transforming to armed police
• ScorerPlayground: Just playground for working with SScorer where I try to make custom menus

Check out ModName/README.md for more info.

Useful links

• Python 1.5.2
• ScrapPackedExplorer (@romibi)
• ScrapHacks - tools and documenation for reverse-engeenering Scrapland (@earthnuker)
• Notes about how game engine works (@earthnuker)
• My mods loader for Scrapland. Depricated, will work on this sometimes later when I learn more about modding Scrapland
• Scrapland Discord server