HideyoshiNakazone/screeps-scripts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added docs and config for pushing to seasonal server (#150)

Browse Source 
* Added docs and config for pushing to seasonal server
* Updated deploy destination docs to use TOKEN authentication
This commit is contained in:
Brandon Risberg
2020-11-29 09:48:13 -08:00
committed by GitHub
parent 0f471f9769
commit e88b608f10
3 changed files with 25 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/in-depth/deploy-destinations.md
View File

@@ -1,13 +1,14 @@
# Deploy destinations # Deploy destinations
The `screeps.json` file is a JSON configuration file separated into multiple deploy destinations. We've given you three primary destinations by default. 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 ```javascript
{ {
// Used for deploying to the main world // Used for deploying to the main world
"main": { "main": {
"email": "you@provider.tld", "token": "YOUR_TOKEN",
"password": "Password",
"protocol": "https", "protocol": "https",
"hostname": "screeps.com", "hostname": "screeps.com",
"port": 443, "port": 443,
@@ -16,18 +17,25 @@ The `screeps.json` file is a JSON configuration file separated into multiple dep
}, },
// Used for deploying to Simulation mode // Used for deploying to Simulation mode
"sim": { "sim": {
"email": "you@provider.tld", "token": "YOUR_TOKEN",
"password": "Password",
"protocol": "https", "protocol": "https",
"hostname": "screeps.com", "hostname": "screeps.com",
"port": 443, "port": 443,
"path": "/", "path": "/",
"branch": "sim" "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 // Used for deploying to a private server
"pserver": { "pserver": {
"email": "username", "token": "YOUR_TOKEN",
"password": "Password",
"protocol": "http", "protocol": "http",
"hostname": "1.2.3.4", "hostname": "1.2.3.4",
"port": 21025, "port": 21025,
@@ -44,4 +52,3 @@ rollup -c --environment DEST:main
``` ```
Omitting the destination will perform a dry run, which will compile and bundle the code without uploading it. Omitting the destination will perform a dry run, which will compile and bundle the code without uploading it.

2
package.json
View File

@@ -9,12 +9,14 @@
"build": "rollup -c", "build": "rollup -c",
"push-main": "rollup -c --environment DEST:main", "push-main": "rollup -c --environment DEST:main",
"push-pserver": "rollup -c --environment DEST:pserver", "push-pserver": "rollup -c --environment DEST:pserver",
"push-season": "rollup -c --environment DEST:season",
"push-sim": "rollup -c --environment DEST:sim", "push-sim": "rollup -c --environment DEST:sim",
"test": "npm run test-unit", "test": "npm run test-unit",
"test-unit": "mocha test/unit/**/*.ts", "test-unit": "mocha test/unit/**/*.ts",
"test-integration": "echo 'See docs/in-depth/testing.md for instructions on enabling integration tests'", "test-integration": "echo 'See docs/in-depth/testing.md for instructions on enabling integration tests'",
"watch-main": "rollup -cw --environment DEST:main", "watch-main": "rollup -cw --environment DEST:main",
"watch-pserver": "rollup -cw --environment DEST:pserver", "watch-pserver": "rollup -cw --environment DEST:pserver",
"watch-season": "rollup -cw --environment DEST:season",
"watch-sim": "rollup -cw --environment DEST:sim" "watch-sim": "rollup -cw --environment DEST:sim"
}, },
"repository": { "repository": {

8
screeps.sample.json
View File

@@ -15,6 +15,14 @@
"path": "/", "path": "/",
"branch": "sim" "branch": "sim"
}, },
"season": {
"token": "YOUR_TOKEN",
"protocol": "https",
"hostname": "screeps.com",
"port": 443,
"path": "/season",
"branch": "main"
},
"pserver": { "pserver": {
"email": "username", "email": "username",
"password": "Password", "password": "Password",