Skip to content

Latest commit

 

History

History
75 lines (55 loc) · 2.95 KB

readme.md

File metadata and controls

75 lines (55 loc) · 2.95 KB
Raw

Renderbus

Render maps of tg- derived Space Station 13 codebases! Now easier than ever!

You'll ned to have docker installed. This repo uses docker to run 3rd party tools instead of having to have them installed on your system locally.

1. First off, build SpacemanDMM:

IN THE PLACE WHERE YOU CLONED SPACEMANDMM:

docker build -t spacemandmm

This builds a SpacemanDMM docker image locally and tags it as spacemandmm.

2. Generate a list of maps to render

We're gonna grab a bunch of json files and parse them to generate our list of maps to render.

You can run this locally, or you can do what I do and use python via docker:

docker run -it --rm \
    -v tgstation/:/tg \
    -v $(pwd):/work:Z \
    -w /work \
    python:3 /work/getmaps.py --codebase /tg --out_dir /output

This is gonna spit out a list of maps to feed to the renderer in step 3.

3. Next, render the maps:

We'll run the spacemandmm docker image we just built, with two volumes mounted:

  • The SS13 codebase you want to render maps from (update this yourself) and
  • The path to your output directory, which will by default be in this directory
docker run --rm \
    -v tgstation/:/tg \ 
    -v $(pwd)/output:/output \
    spacemandmm --env /tg/tgstation.dme \
    minimap /tg/_maps/map_files \
    -o /output

Go ahead and run the command above (after you change it to reflect your local filesystem). By itself, this command should spit out the help text. Copy the output from step 2 and paste it at the end of the command above, so you wind up with something like this:

docker run -v tgstation/:/tg -v $(pwd)/output:/output spacemandmm --env /tg/tgstation.dme minimap -o /output  /tg/_maps/map_files/Birdshot/birdshot.dmm /tg/_maps/map_files/Deltastation/DeltaStation2.dmm /tg/_maps/map_files/IceBoxStation/IceBoxStation.dmm /tg/_maps/map_files/MetaStation/MetaStation.dmm /tg/_maps/map_files/debug/multiz.dmm /tg/_maps/map_files/NorthStar/north_star.dmm /tg/_maps/map_files/debug/runtimestation.dmm /tg/_maps/map_files/tramstation/tramstation.dmm

There's probably a better way to do this, but for now the quick n' dirty way is fine. Once you have your map list appended properly, run the command and render your maps.

4. Crush them as though they were your enemies

The resulting PNG files created by SpacemanDMM (~16mb) are huge. So we'll run 'em through pngcrush:

./crush.sh output/

(this will take quite a while)

5. Generate the viewer

We'll use docker again to generate the html page for viewing maps:

docker run -it --rm -v $(pwd):/work -w /work node:latest npx --yes @11ty/eleventy

This is probably overkill, but it's future proof when this application inevitably gets more complicated.

6. Upload your files

The contents of the output/ directory are the files you ned for your webserver. Here's an example of how I upload the files, using rsync:

rsync -Pav renderbus.statbus.space/output/* [email protected]:/var/www/renderbus.statbus.space/