Nuclear 14 Contributor's Guide

Nuclear 14 is based on Space Station 14 (the upstream), which has developer documentation that cover most things that you might want to do that aren't described here.

Mapping

You can help map for Nuclear 14 by following the upstream mapping guide. This involves setting up a development environment, cloning the Nuclear 14 repository, and mapping on your local development server.

Alternatively, you can map on our official mapping server:

  1. Ask for a @mapper role on our Discord. This grants you whitelist access to the mapping server.
  2. Install Space Station 14 and open the launcher.
  3. Add the mapping server to your launcher. (1) Click "Add Favorite..." (2) Fill in "Nuclear 14 (Mapping)" as the name and "ss14://nuclear14.com:1401" as the address (3) Click "Add"
  4. Connect to the mapping server from the launcher. If you cannot connect, either the mapping server is down, or you have not been approved for the whitelist. In both cases, contact us on Discord.
  5. Follow the upstream mapping guide from the Start Mapping section.
  6. When saving your map, save to a path unique to you. For example, if your SS14 username is fluff, you should save your map to /fluff/my_map.yaml.
  7. Contact us on Discord when you are ready for feedback on your map. Your map does not have to be finished for us to give feedback; get feedback early!

Spriting

To be written

Contributing Files

You can contribute files (for example, when mapping and spriting) through the Github web UI without having to install and use Git:
  1. Go to our Github page and fork our repository:
    Click "Fork" Accept the defaults and click "Create Fork"
  2. You should end up at the page for your fork of Nuclear 14. Navigate to the folder where you want to upload your files.
  3. Use the "Add files" and "Upload files" drop down to upload your files Click "Add file" then "Upload files"
  4. On the file upload screen: File upload screen
    1. Drag the files you want to upload
    2. Give your change a descriptive title and description
    3. Select "Create a new branch" and name your branch (no spaces)
    4. Click "Propose changes"

Cloning Nuclear 14

From the command line:
git clone https://github.com/Vault-Overseers/nuclear-14.git