Skip to content

Commit e88b608

Browse files
authoredNov 29, 2020
Added docs and config for pushing to seasonal server (screepers#150)
* Added docs and config for pushing to seasonal server * Updated deploy destination docs to use TOKEN authentication
1 parent 0f471f9 commit e88b608

File tree

3 files changed

+25
-8
lines changed

3 files changed

+25
-8
lines changed
 

‎docs/in-depth/deploy-destinations.md

+15-8
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
# Deploy destinations
22

3-
The `screeps.json` file is a JSON configuration file separated into multiple deploy destinations. We've given you three primary destinations by default.
3+
The `screeps.json` file is a JSON configuration file separated into multiple deploy destinations. We've given you four primary destinations by default.
4+
5+
See [here](/docs/getting-started/authenticating.md) for steps to generate your API token.
46

57
```javascript
68
{
79
// Used for deploying to the main world
810
"main": {
9-
"email": "you@provider.tld",
10-
"password": "Password",
11+
"token": "YOUR_TOKEN",
1112
"protocol": "https",
1213
"hostname": "screeps.com",
1314
"port": 443,
@@ -16,18 +17,25 @@ The `screeps.json` file is a JSON configuration file separated into multiple dep
1617
},
1718
// Used for deploying to Simulation mode
1819
"sim": {
19-
"email": "you@provider.tld",
20-
"password": "Password",
20+
"token": "YOUR_TOKEN",
2121
"protocol": "https",
2222
"hostname": "screeps.com",
2323
"port": 443,
2424
"path": "/",
2525
"branch": "sim"
2626
},
27+
// Used for deploying to Seasonal Event server
28+
"season": {
29+
"token": "YOUR_TOKEN",
30+
"protocol": "https",
31+
"hostname": "screeps.com",
32+
"port": 443,
33+
"path": "/season",
34+
"branch": "main"
35+
},
2736
// Used for deploying to a private server
2837
"pserver": {
29-
"email": "username",
30-
"password": "Password",
38+
"token": "YOUR_TOKEN",
3139
"protocol": "http",
3240
"hostname": "1.2.3.4",
3341
"port": 21025,
@@ -44,4 +52,3 @@ rollup -c --environment DEST:main
4452
```
4553

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

‎package.json

+2
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,14 @@
99
"build": "rollup -c",
1010
"push-main": "rollup -c --environment DEST:main",
1111
"push-pserver": "rollup -c --environment DEST:pserver",
12+
"push-season": "rollup -c --environment DEST:season",
1213
"push-sim": "rollup -c --environment DEST:sim",
1314
"test": "npm run test-unit",
1415
"test-unit": "mocha test/unit/**/*.ts",
1516
"test-integration": "echo 'See docs/in-depth/testing.md for instructions on enabling integration tests'",
1617
"watch-main": "rollup -cw --environment DEST:main",
1718
"watch-pserver": "rollup -cw --environment DEST:pserver",
19+
"watch-season": "rollup -cw --environment DEST:season",
1820
"watch-sim": "rollup -cw --environment DEST:sim"
1921
},
2022
"repository": {

‎screeps.sample.json

+8
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,14 @@
1515
"path": "/",
1616
"branch": "sim"
1717
},
18+
"season": {
19+
"token": "YOUR_TOKEN",
20+
"protocol": "https",
21+
"hostname": "screeps.com",
22+
"port": 443,
23+
"path": "/season",
24+
"branch": "main"
25+
},
1826
"pserver": {
1927
"email": "username",
2028
"password": "Password",

0 commit comments

Comments
 (0)
Please sign in to comment.