Deploy destinations

The screeps.json file is a JSON configuration file separated into multiple deploy destinations. We've given you four primary destinations by default.

See here for steps to generate your API token.

{
  // Used for deploying to the main world
  "main": {
    "token": "YOUR_TOKEN",
    "protocol": "https",
    "hostname": "screeps.com",
    "port": 443,
    "path": "/",
    "branch": "main"
  },
  // Used for deploying to Simulation mode
  "sim": {
    "token": "YOUR_TOKEN",
    "protocol": "https",
    "hostname": "screeps.com",
    "port": 443,
    "path": "/",
    "branch": "sim"
  },
  // Used for deploying to Seasonal Event server
  "season": {
    "token": "YOUR_TOKEN",
    "protocol": "https",
    "hostname": "screeps.com",
    "port": 443,
    "path": "/season",
    "branch": "main"
  },
  // Used for deploying to a private server
  "pserver": {
    "token": "YOUR_TOKEN",
    "protocol": "http",
    "hostname": "1.2.3.4",
    "port": 21025,
    "path": "/",
    "branch": "main"
  }
}

You can make as many separate destinations as you want. Just make a copy of any config object and perform the necessary changes. Once you're done, use the --environment DEST:<dest> argument on the rollup command to specify which environment to upload to.

rollup -c --environment DEST:main

Omitting the destination will perform a dry run, which will compile and bundle the code without uploading it.