Files
screeps-scripts/docs/in-depth/deploy-destinations.md
Brandon Risberg e88b608f10 Added docs and config for pushing to seasonal server (#150)
* Added docs and config for pushing to seasonal server
* Updated deploy destination docs to use TOKEN authentication
2020-11-29 19:48:13 +02:00

55 lines
1.5 KiB
Markdown

# 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](/docs/getting-started/authenticating.md) for steps to generate your API token.
```javascript
{
// 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.
```bash
rollup -c --environment DEST:main
```
Omitting the destination will perform a dry run, which will compile and bundle the code without uploading it.