Papers, Please -  Arstotzkan Adjustments & Modding System
_______________________________________________________________________________

"Papers, Please" implements a simple modding system that allows replacing of 
any image, text, or script asset in the game without affecting the original 
data. Mods can be distributed as single cross-platform files that work on both 
Windows and OSX.

Mods may not be enabled for the final release of the game. Please keep this
in mind before putting a lot of work into one. It's possible they can only 
ever be played using pre-release versions of the game.

_______________________________________________________________________________
Legal

I offer no warranty and take no responsibility for the content of user mods
or any effects they have. Editing or playing mods may break you and/or your 
computer.

_______________________________________________________________________________
Mod Help and Support

There is none. Please don't ask me for any. I threw this system together to 
make it easier for those interested but I don't have the resources to offer 
any help or support in creating them. Sorry.

_______________________________________________________________________________
Making a Mod

1. Download the game's uncompressed assets from http://dukope.com#ppl
2. Unzip all files into a new directory somewhere (eg: C:/PPMods/rocktown/)
3. Edit rocktown/_mods.xml to specify the name, author, and url (all required)
4. Edit any assets
5. Run PapersPlease from the command line and add "/full/path/to/rocktown"
 
Windows (Using cmd):  'PapersPlease.exe /full/path/to/rocktown'
OSX (using Terminal): 'open PapersPlease.app --args /full/path/to/rocktown'

Multiple mods can be run at once. Order determines priority.

_______________________________________________________________________________
Distributing a Mod as .ppmod

For distribution, zip up the subdirectory (preserving paths) and rename the 
extension to .ppmod:

    /full/path/to/rocktown -> rocktown.zip -> rocktown.ppmod

_______________________________________________________________________________
Playing a .ppmod

Windows: 
1. Put the .ppmod to the same directory as PapersPlease.exe
2. Drag and drop the .ppmod file onto PapersPlease.exe

OSX:
1. From Terminal, cd to the directory containing PapersPlease.app 
2. Type 'open PapersPlease.app --args /full/path/to/rocktown.ppmod'

_______________________________________________________________________________
Files

Only the modified files need to be present in the mod subdir. If you change 
just a few images, remove all other files before distributing. This will
improve the likelihood that your mod works with future builds of the game.
Files not found in the mod subdir will fall back to the game's original assets.

_______________________________________________________________________________
Errors

The game is not forgiving about format or content differences from the original
assets. It also doesn't print useful errors or give any information about why
something doesn't work. Also there's no version checking so some mods may break
later game versions.

_______________________________________________________________________________

