One day, this is planned to be a full set of editing tools for System Shock - a map and gamesys editor, and converters between SS1 art formats to standard formats that can be edited with existing tools.

At the moment, however, it consists of two tools: `res`, for unpacking (and, eventually, packing) resource files, and `map` for generating pretty HTML5 maps of System Shock levels. Run them without arguments for help. It depends on vstruct[1] and kineticJS[2]. A recent version of kineticJS is included as `kinetic.js`; you'll need to put this in the same directory as the generated map files for them to work.

The generated maps have gotten too large to reasonably commit, so they aren't committed anymore; you can find them at http://funkyhorror.ancilla.ca/toxicfrog/ss1/maps/

Note that unpacking compressed resource files - especially ARCHIVE.DAT, which contains several megabytes of compressed data - is *slow*. It is highly recommended that you create an uncompressed version of ARCHIVE.DAT; the included Makefile will do this automatically, or you can do it yourself using the `res d` command.

[1] https://github.com/ToxicFrog/vstruct
[2] http://kineticjs.com/

## Installation

You'll need Lua 5.2 installed (or LuaJIT 2.0.0 or later -- the beta versions won't work). For some features, you will also need luafilesystem; if you're using LuaForWindows or LuaDist, that should come built-in. Otherwise, install it via your package manager or LuaRocks.

 All other dependencies are pulled in via submodules:

    git clone git://github.com/toxicfrog/ss1edit.git
    cd ss1edit
    git submodule init
    git submodule update

After that, you should be good to go. You will of course need a copy of System Shock to do anything interesting with it. If you drop a copy of ARCHIVE.DAT in the ss1edit directory -- or a save file renamed ARCHIVE.DAT -- the included Makefile will automatically turn it into maps for you.

## License

Copyright © 2014 Ben "ToxicFrog" Kelly, Google Inc.

Distributed under the Apache License v2; see the file COPYING for details.

### Disclaimer

This is not an official Google product and is not supported by Google.