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

[docs] add more sections

Browse Source
This commit is contained in:
Resi Respati
2017-11-28 13:05:07 +07:00
parent b068c6bb78
commit 6e9088c7ca
10 changed files with 117 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
docs/getting-started/deploying.md
View File

@@ -1,6 +1,6 @@
# Deploying
## Building Your Configuration File
## Building your configuration file
The starter kit builds your code using `rollup`, which uses a `screeps.json` file as its configuration file. A sample config file is provided within the project, to use it, simply make a copy and rename it to `screeps.json`.
@@ -10,50 +10,11 @@ cp screeps.sample.json screeps.json
> **IMPORTANT:** The `screeps.json` file contains your Screeps credentials. If you use any source control, **DO NOT** check in this file into your repository.
[TODO: move to 'in-depth']
The `screeps.json` file is a JSON configuration file separated into multiple environments. We're going to focus on the `main` environment to get you starter. Fill in your Screeps credentials accordingly, along with your target branch.
The `screeps.json` file is a JSON configuration file that can be separated into multiple environments. We've given you three primary environments by default.
![deploying-1](img/deploying-1.png)
```json
{
// Used for deploying to the main world
"main": {
"email": "you@provider.tld",
"password": "Password",
"protocol": "https",
"hostname": "screeps.com",
"port": 443,
"path": "/",
"branch": "main"
},
// Used for deploying to Simulation mode
"sim": {
"email": "you@provider.tld",
"password": "Password",
"protocol": "https",
"hostname": "screeps.com",
"port": 443,
"path": "/",
"branch": "sim"
},
// Used for deploying to a private server
"pserver": {
"email": "username",
"password": "Password",
"protocol": "http",
"hostname": "1.2.3.4",
"port": 21025,
"path": "/",
"branch": "main"
}
}
```
[/TODO: move to 'in-depth']
We're going to focus on the `main` environment as a starter. Fill in your Screeps credentials accordingly, along with your target branch.
> **Note:** You don't have to manually create the branch in your Screeps client if it doesn't exist yet. `rollup` will do it for you.
> **Note:** You don't have to manually create the target branch in your Screeps client if it doesn't exist yet. `rollup-plugin-screeps` will do it for you.
## Running Your First Deploy
@@ -65,6 +26,6 @@ npm run push-main
You're done! Now go to your Screeps client and make sure your code is deployed properly.
![deploying-1](img/deploying-1.png)
![deploying-2](img/deploying-2.png)
Ready for something extra? Read on.