.\n","_id":"@arcadia-screeps/deploy-wizard@1.0.3","dist":{"shasum":"dd622653dda596332a2846efdafad402be834f57","integrity":"sha512-20LZ+gLgnWBJLIagVsEz7QrVq60oBV6GRBkJEtFtzijrIHxuVcx7w6BjNO2H1/ZWbP0zRc/P8QvZrS04w4yj1w==","tarball":"https://registry.npmjs.org/@arcadia-screeps/deploy-wizard/-/deploy-wizard-1.0.3.tgz","fileCount":69,"unpackedSize":118669,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQDFVP5xSRtWQ9pZnFYkhK3a8Z9MsSEqLgz2ncSeL5Y7uQIgGJiAMAbEp/GIXtJwWRxXXkybHwnmbxDa4KwxkLXOCFY="}]},"_npmUser":{"name":"peachest","email":"houyx2012@126.com"},"directories":{},"maintainers":[{"name":"peachest","email":"houyx2012@126.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/deploy-wizard_1.0.3_1708264231871_0.7293272505636446"},"_hasShrinkwrap":false}},"maintainers":[{"name":"peachest","email":"houyx2012@126.com"}],"description":"A CLI for screeps server based on screep-launcher","homepage":"https://github.com/arcadia-screeps","keywords":["cli","server","screeps","docker","docker-compose"],"repository":{"type":"git","url":"https://github.com/arcadia-screeps/deploy-wizard"},"author":{"name":"peachest","email":"1938913473@qq.com"},"bugs":{"url":"https://github.com/arcadia-screeps/deploy-wizard/issues"},"license":"GPL-3.0","readme":"# screeps-deploy-wizard\n\n![\"NPM](\"https://img.shields.io/npm/v/%40arcadia-screeps%2Fdeploy-wizard?logo=npm\"/)
![\"GitHub](\"https://img.shields.io/github/v/release/arcadia-screeps/deploy-wizard\"/)
![\"NPM](\"https://img.shields.io/npm/dt/%40arcadia-screeps%2Fdeploy-wizard?label=total%20downloads\")
![\"GitHub](\"https://img.shields.io/github/license/arcadia-screeps/deploy-wizard\"/)
\n\n \n
\n
\n ![\"Logo\"](\"./images/logo.png\")
\n
\n
\nA CLI for screeps server based on screep-launcher\n
\n
\n English\n ·\n 简体中文\n
\n
\n Usage\n ·\n Report Bug\n ·\n Propose Feature\n
\n
\n Screeps\n ·\n Screeps Launcher\n
\n
\n \n ![\"Stat\"/](\"https://stats.deeptrain.net/repo/arcadia-screeps/deploy-wizard\")
\n \n
\n\n\n\n\n## Table of Contents\n\n- [Description](#Description)\n- [Compatibility](#Compatibility)\n- [Environment](#Environment)\n- [Installation](#Installation)\n- [Usage](#Usage)\n - [Primary Preset](#Primary-Preset)\n - [Advanced Preset](#Advanced-Preset)\n - [Config Steam API Key](#Config-Steam-API-Key)\n- [CLI Configuration](#CLI-Configuration)\n - [Language](#Language)\n- [Build](#Build)\n- [FAQs](#FAQs)\n- [Compare](#Compare)\n - [screeps](#screeps)\n - [screeps-launcher](#screeps-launcher)\n - [screeps-deploy-wizard(This Project)](#This-Project)\n\n\n\n## Description\n\nA CLI for screeps server based on screep-launcher. Used for generating the `config.yaml` required by screeps-launcher, as well as providing some other utility features.\n\nThis CLI provides two preset startup modes:\n\n1. Bare-metal startup. Disables screepsmod-mongo.\n2. Docker startup. Enforces the use of screepsmod-mongo.\n\n| Startup Mode | 不安装 mongo mod | 安装 mongo mod |\n| ------------ | -------------------------------------------------------- | ------------------------------------------------------------ |\n| Bare-metal | Startup directly using screeps-launcher (primary preset) | Requires manual installation of mongo and redis on bare metal and manual management (not recommended). |\n| Docker | Using storage based on the LokiJS library | Service automated management (advanced preset). |\n\n:bulb:Based on screeps-launcher, `screepsmod-admin-util` must be installed to allow parsing of the `server-config` section in `config.yaml`. \n\n[↑ back to top]
\n\n## Compatibility\n\nThis CLI is compatible for the following platforms:\n\n- Windows\n- Linux\n\n:bulb: Mac platform has not been tested.\n\n\n\n## Environment\n\n* Node.js 16 LTS or higher version\n* Docker (if using advanced presets)\n\n[↑ back to top]
\n\n## Installation\n\n### Source Code\n\nDownload the latest release package from the [Releases](https://github.com/arcadia-screeps/deploy-wizard/releases/) page of this project's GitHub repository.\n\nTo build from source code, refer to the [Build](https://chatnio.net/#Build) section.\n\n### NPM\n\nPull from NPM:\n\n```sh\nnpm i -g @arcadia-screeps/deploy-wizard\n\n# or\n\nyarn global add @arcadia-screeps/deploy-wizard\n```\n\n[↑ back to top]
\n\n## Usage\n\nView the help information\n\n```sh\nscreeps-deploy-wizard\nscreeps-deploy-wizard --help\n\n# or use the abbreviation\n\nsdw\nsdw --help\n```\n\n[↑ back to top]
\n\n### Primary Preset\n\nInitialize and generate `config.yaml` for launching with screeps-launcher.\n\n```sh\nsdw init\n```\n\nFollow the interactive command line and select the `Primary` preset.\n\n[↑ back to top]
\n\n### Advanced Preset\n\nInitialize and generate `config.yaml` and `docker-compose.yaml` for starting up docker service\n\n```sh\nsdw init\n```\n\nFollow the interactive command line and select the `Advanced` preset.\n\n\n\nUse Docker to start the service defined in `docker-compose.yaml`.\n\n```sh\nsdw start\n```\n\n\n\nThe `screeps-server` container uses the `screeps-launcher` image. When the container starts, it will parse the `config.yaml`, install the runtime environment and specified mods, and finally start the Screeps server. This process may take a while. Please check the container logs to confirm the progress.\n\nOutput logs of screeps-server container\n\n```sh\nsdw logs\n```\n\nWait for the logs to stop scrolling and output similar information as shown below. This indicates that the Screeps server has started successfully, and players can connect to it using the Steam client.\n\n```sh\n2024/01/31 14:38:05 Initializing server\n2024/01/31 14:38:05 Writing mods.json\n2024/01/31 14:38:05 Writing 9 mods and 1 bots\n2024/01/31 14:38:05 Starting Server\n2024/01/31 14:38:05 Started\n2024/01/31 14:38:05 [main] exec: screeps-engine-main\n2024/01/31 14:38:05 [runner] exec: screeps-engine-runner\n2024/01/31 14:38:05 [backend] exec: screeps-backend\n2024/01/31 14:38:05 [processor_0] exec: screeps-engine-processor\n2024/01/31 14:38:05 [processor_1] exec: screeps-engine-processor\n```\n\n\n\nAccess the address `http://localhost:21025/web/` in your browser. Run a command on host to verify if the Screeps server is responding correctly:\n\n```sh\ncurl http://localhost:21025/web/\n```\n\n:bulb: Please note that when accessing it from the command line, you must include the `/web/` slash. (This website is provided by `screepsmod-admin-utils-ui`).\n\n\n\n****\n\nTo initialize the database or clear all user data, first connect to the CLI of `screeps-launcher`:\n\n```sh\nsdw\tcli\n\n# Equivalent to executing the command `screeps-launcher cli` inside the screeps-server container.\n\ndocker exec -ti screeps-server screeps-launcher cli\n```\n\n:warning:Note: It is necessary to include the `-ti` option, otherwise it may display error messages: `panic: no such device or address`\n\nThen run command in CLI:\n\n```sh\nsystem.resetAllData()\n```\n\nfinally exit CLI using `Ctrl-d`. It is best to restart the container.：\n\n```sh\nsdw restart\n```\n\n\n\n****\n\nIf you want to terminate the service, execute the following command to exit and remove all containers related to the service.\n\n```sh\nsdw stop\n```\n\n[↑ back to top]
\n\n### Config Steam API Key\n\nStarting Screeps server requires your Steam API Key. Screeps-launcher provides two methods for configuration.\n\n1. config in `config.yaml` file\n\n ```yaml\n # config.yaml\n steamKey: # your Steam API Key\n ```\n\n2. Store Steam API Key in a separate file and specify the file path in `config.yaml`.\n\n ```yaml\n # config.yaml\n steamKeyFile: \"STEAM_KEY\" # Default\n ```\n\n and then create `STEAM_KEY` file\n\n ```sh\n echo \"replace your Steam API Key here\" > STEAM_KEY\n ```\n\n your directory structure should look like this:\n\n ```sh\n .\n ├── config.yml\n ├── docker-compose.yml (高级预设)\n └── STEAM_KEY\n ```\n\n\n:warning: If the STEAM_KEY file is configured but not placed, the screeps-launcher container will keep restarting.\n\n[↑ back to top]
\n\n## CLI Configuration\n\nYou can configure this CLI in two ways:\n\n1. Use `sdw config` command to manage all configuration options.\n2. Modify the configuration file directly.\n\n\n\nPath for configuration file：\n\n* Linux and Mac：`$HOME/.screep-deploy-wizard/config.json`\n\n* Windows：`$HOME\\.screep-deploy-wizard\\config.json`\n\n\n\n### Language\n\nThis CLI supports both English and Chinese languages. You can use the `language` configuration option to switch between languages.\n\n```sh\n# English\nsdw config set language en\n\n# Chinese\nsdw config set language zh\n```\n\n[↑ back to top]
\n\n## Build\n\nAfter pulling the project to local, you need to build it before you can use it. First, cd into project root using `cd deploy-wizard`, and then execute the following command:\n\n```sh\nnpm build\n\n# or\n\nyarn build\n```\n\n\n\nIf you want to use the command in any directory, you need to add it globally\n\n```sh\nnpm link\n```\n\n[↑ back to top]
\n\n## FAQs\n\n### Why does the server take a long time to respond when it is first started?\n\nBecause the `screeps-launcher` container will pull the `screeps`, `mod`, and other Node.js dependencies based on the configuration. This process can take some time to complete.\n\n\n\n### Why there is no need to wait when the server restarts or stops and then starts again.\n\nBecause the server container is configured with a volume. This volume stores the runtime dependencies and configuration files, so the `screeps-launcher` does not need to pull dependencies again and can start directly.\n\n[↑ back to top]
\n\n### How to access Dashboard\n\nAfter enabling `screepsmod-admin-util`, it provides a web-based dashboard for the server, which can be accessed in a browser by visiting `http://{{Your server ip}}:21025`.\n\nThe webpage includes a dashboard with the following information:\n\n- Tick Rate variation\n- Current Tick of the server\n- Active users\n- Total number of Creeps\n- Rooms occupied by players\n- Rooms active with player activity\n\nAnd a LeaderBoard to view the player rankings for the following resources separately:\n\n* GCL\n* Power\n* Rooms\n* RCL\n\n[↑ back to top]
\n\n### How to modify the server configuration during runtime\n\nWhen most of the configurations within the `serverConfig` section of the `config.yml` file are modified, they are instantly reloaded into the server.\n\n:bulb: For specific configuration options, please refer to the [screeps-launcher](https://chatnio.net/#screeps-launcher) chapter and the detailed documentation of each mod.\n\nYou can modify the `config.yml` file without entering the container. By inspecting the generated `docker-compose.yml`, you can see that the `config.yml` file is mounted into the container as a bind mount. Therefore, you can directly modify the `config.yml` file on the host machine, and these changes will be synchronized to the container.\n\nFor example, if you change `serverConfig.tickRate` from 1000 to 2000 and then check the Web Dashboard, you will see that the server's Tick Rate has increased.\n\n[↑ back to top]
\n\n### How to list volumes and inspect mount point\n\n**List volumes**\n\nIf not modified, the default volume names are:\n\n* `screeps_server-data`：volume for screeps-launcher container，default mounting to `/screeps` dir\n* `screeps_mongo-data`：volume for mongo\n* `screeps_redis-data`：volume for redis\n\n\n\nExecute command to list all volumes:\n\n```sh\ndocker volume ls | grep \"screeps\"\n```\n\n\n\n****\n\n**Inspect mount point**\n\nTake `screeps_server-data` volume as example, inspect the detailed information of volume:\n\n```sh\ndocker volume inspect screeps_server-data\n```\n\nThe output result look like this:\n\n```json\n{\n \t//...\n \"Mountpoint\": \"/var/lib/docker/volumes/screeps_server-data/_data\",\n\t //...\n}\n```\n\n\n\ncd into mount point and look around:\n\n```sh\ncd /var/lib/docker/volumes/screeps_server-data/_data\n```\n\n\n\nor execute the following quick command:\n\n```sh\ncd $(docker volume inspect screeps_server-data | jq '.[0].Mountpoint' | sed 's|\\\"||g')\n```\n\n[↑ back to top]
\n\n### Why get stuck on title screen when starting up Stream client\n\nReason：Screeps is updating its `package.nw` file.\n\nSolution: Manually download the latest version of the file and replace it.\n\n- Right-click on the game in the Steam library - Manage - Browse Local Files, open Screeps worlds in the file manager. You will find a `package.nw` file and a `package.nw.new` file that is currently downloading the latest version.\n- Visit the [official website](https://screeps.com/api/version) to check the latest version, and examine the `package` field. The current latest version is `224`.\n- Concatenate the version number into the download link: `https://screeps.com/packages/224`, access the link to download the file, and the file name will default to the version number.\n- Rename the file to `package.nw` and replace it in the game directory.\n\nReference post：[screeps world卡在nw.js界面](https://blog.csdn.net/weixin_44083915/article/details/134097416)\n\n[↑ back to top]
\n\n\n\n## Compare\n\n### screeps\n\nDescription of official project [screeps](https://github.com/screeps/screeps)\n\n>This project is a distributed, standalone game server that allows you to launch your own game world on a local computer or dedicated server on the Internet.\n>\n\nScreeps provides an official npm package. However, the project has not been updated for a long time, and the latest version [Release v3.4.0](https://github.com/screeps/screeps/releases/tag/v3.4.0) was released in 2019. The required environment for installation and runtime are very outdated, including nodegyp and python2. The best practise is install the screeps package on the node:10 environment on Ubuntu.\n\n```sh\n# Input Steam API Key\nnpx screeps init\n\n# Start server\nnpx screeps start\n\n# Connect to CLI of screeps server. Must start the server first\nnpx screeps cli\n>> help() # use help() to check available commands\n```\n\n\n\nFor the sake of not disrupting the server environment, it is best to package it into an image and run it. Below is an unofficial Dockerfile.\n\n```dockerfile\nARG STEAM_API_KEY\n\n# Staged build image\n# BUILDER stage use ubuntu image to install node package\nFROM ubuntu:16.04 AS BUILDER\n\n# Change source if neccessary, and download environment\nRUN sed -i 's@//.*archive.ubuntu.com@//mirrors.ustc.edu.cn@g' /etc/apt/sources.list && \\\n apt update && \\\n apt install -y build-essential tcl git curl gcc g++ make\n\n# Install node:10.x\nRUN curl -sL https://deb.nodesource.com/setup_10.x | bash - && \\\n apt install -y nodejs\n\n# Install yarn\nRUN curl -sL https://dl.yarnpkg.com/debian/pubkey.gpg | gpg --dearmor | tee /usr/share/keyrings/yarnkey.gpg >/dev/null && \\\n echo \"deb [signed-by=/usr/share/keyrings/yarnkey.gpg] https://dl.yarnpkg.com/debian stable main\" | tee /etc/apt/sources.list.d/yarn.list && \\\n apt-get update && apt-get install -y yarn\n\n# Create and switch working dir\nWORKDIR /screeps\n\n# yarn change source and download mod and screeps server package\nRUN yarn config set registry https://registry.npmmirror.com && \\\n yarn add \\\n screepsmod-admin-utils \\\n screepsmod-mongo \\\n screepsmod-auth \\\n screepsmod-features \\\n screeps\n\nFROM node:10.24-slim AS base-server\nARG STEAM_API_KEY\n# Running with screeps user instead of root\nRUN groupadd --gid 1000 screeps \\\n && useradd --uid 1000 --gid screeps --shell /bin/bash --create-home screeps \\\n && mkdir /screeps && chown screeps.screeps /screeps\nUSER screeps\n# Expose /screeps volume\nVOLUME /screeps\nWORKDIR /screeps\n\n# Copy node_modules, package.json, yarn.lock from BUILDER stage\nCOPY --from=BUILDER /screeps/ ./\n# Override default screep configuration\nCOPY ./mods.json ./.screepsrc ./\n# Initial with STEAM_API_KEY parameter\nRUN sh -c '/bin/echo \"${STEAM_API_KEY}\" | npx screeps init'\nENTRYPOINT [\"npx\", \"screeps\", \"start\"]\n```\n\n\n\n:bulb: Instructions:\n\n1. Create a new folder named `screeps-server` to store the `Dockerfile` and other files.\n\n2. Create a file named `mods.json` with the following content:\n\n ```json\n {\n // List of enabled mods. It must be a subset of all installed mods\n \"mods\": [\n \"node_modules/screepsmod-mongo/index.js\",\n \"node_modules/screepsmod-auth/index.js\",\n \t \"node_modules/screepsmod-tickrate/index.js\",\n \t\"node_modules/screepsmod-admin-utils/index.js\",\n \t\"node_modules/screepsmod-features/index.js\"\n ],\n \n // scripts for npc bot\n \"bots\": {\n \"simplebot\": \"node_modules/@screeps/simplebot/src\"\n }\n }\n ```\n\n3. Create a `.screepsrc` file in INI format. When using `screeps start [option]` command to start, all options will be automatically saved to this file, so you can also directly modify the `.screepsrc` file to specify the server startup options.\n\n ```ini\n ;If you launch the server without running the local Steam client,\n ;then the Steam Web API key is required for authenticating users.\n ;It can be obtained on this page: http://steamcommunity.com/dev/apikey\n steam_api_key = \n \n ;The port number on which the game server should listen.\n port = 21025\n \n ;The hostname on which the game server should listen.\n host = 0.0.0.0\n \n ;The server password which should be provided on user sign in.\n password =\n \n ;The port number on which the CLI server should listen. Defaults to port+1.\n cli_port = 21026\n \n ;The hostname on which the CLI server should listen.\n cli_host = localhost\n \n ;The number of player runner worker processes to launch.\n ;Setting this option to more than 1 will lead to multiple simultaneous global environments\n ;for each player, it is not recommended for basic setup.\n runners_cnt = 1\n \n ;The number of parallel runner threads in which player scripts are executed. Don't set this\n ;option greater than the number of your physical CPU cores.\n runner_threads = 4\n \n ;The number of room processor worker processes to launch. Don't set this\n ;option greater than the number of your physical CPU cores.\n processors_cnt = 2\n \n ;The path to directory where logs will be created.\n logdir = logs\n \n ;The path to JSON file with the list of custom mods to load.\n modfile = mods.json\n \n ;The path to directory where static assets are located.\n assetdir = assets\n \n ;The path to the database file.\n db = db.json\n \n ;If set, forward console messages to terminal\n log_console = false\n \n ;How many log files to keep when rotating.\n log_rotate_keep = 5\n \n ;If set, disable built-in storage, useful when you use some other implementation.\n storage_disabled = false\n \n ;Automatically restart child processes.\n restart_interval = 3600\n ```\n\n4. Use the following command to build image:\n\n ```sh \n docker build \\\n \t--network host \\ # 指定 host 网络，以安装环境依赖\n \t--build-arg STEAM_API_KEY=\"\" \\ # 指定服务器使用的 STEAM_API_KEY\n \t-f ./dockerfile \\ # 指定 dockerfile 路径\n \t-t screeps-server:latest \\ # 指定镜像名 \n \t.\n ```\n\n5. Use the following command to run container:\n\n ```sh\n docker run \\\n \t-d \\ # 以后台模式运行，避免关闭终端后容器立刻终止\n \t--name screeps-server \\ # 指定容器名\n \t-v screeps-server:/screeps \\ # 使用卷标，由 docker 自动创建卷\n \t-p 21025:21025 \\ # 暴露 21025 接口，以便容器可以向外提供服务\n \tscreeps-server:latest\n ```\n\n[↑ back to top]
\n\n### screeps-launcher\n\nscreeps-launcher use `config.yaml`（or `config.yml`）as configuration file. The following configuration options and their default values are obtained from the screeps-launcher source code.\n\n```yml\n# config.yaml\nsteamKey: # your Steam API key\nsteamKeyFile: \"STEAM_KEY\" # Path to Steam API key file\ncli: # screeps-launcher CLI configuration. Default to screeps cli\n host: \"127.0.0.1\"\n port: 21026\n username: \"\"\n password: \"\"\nenv: # Environment variable configuration. Will be applied to screeps server and mods\n shared:\n MODFILE: \"mods.json\"\n STORAGE_HOST: \"127.0.0.1\",\n STORAGE_PORT: \"21027\", \n backend:\n GAME_HOST: \"0.0.0.0\",\n GAME_PORT: \"21025\",\n CLI_HOST: \"127.0.0.1\",\n CLI_PORT: \"21026\",\n ASSET_DIR: \"assets\",\n engine:\n DRIVER_MODULE: \"@screeps/driver\",\n storage: \n DB_PATH: \"db.json\",\nprocessors: # Default to runtime.NumCPU()\nrunnerthreads: # Default to math.Max(1, float64(processors)-1)\nversion: \"latest\" # Specified screeps version. Default to latest\nnodeVersion: \"Erbium\" # Specified Nodejs version. Default to Erbium\nmods: # mod config list\nbots: # bot config list\nextraPackages:\npinnedPackages:\n ssri: \"8.0.1\",\n cacache: \"15.3.0\",\n passport-steam: \"1.0.17\",\n minipass-fetch: \"2.1.2\",\n express-rate-limit: \"6.7.0\",\nlocalMods: \"./mods\" # Directory of local mod\nbackup: # 配置备份\n dirs: # 备份目录列表\n files: # 备份文件列表\nmodules: # modules used by screeps server, check https://github.com/screeps/screeps?tab=readme-ov-file#modules\n backend: true\n main: true\n processor: true\n runner: true\n storage: true\n```\n\n\n\n****\n\nIf installed [screepsmod-admin-utils](https://github.com/ScreepsMods/screepsmod-admin-utils), you can add a section named `serverConfig` to the `config.yaml` file. The recognized fields and their default values for `screepsmod-admin-utils` are as follows:\n\n```yaml\n# config.yaml\n# Most of these fields will live reload on save. \n# Values set here will override any saved via CLI on server startup\nserverConfig: \n map: random_1x2 # utils.importMap will be called automatically with this value, see utils.importMap above\n tickRate: 200\n socketUpdateRate: 200\n whitelist: # Does not restrict login, only restricts spawning\n - ags131\n - zeswarm\n shardName: 'screepsplus1' # Default to hostname of host\n constants:\n \t# Default 1000000\n \tGCL_MULTIPLY:\n \t# Default 2.4\n \tGCL_POW: \n UPGRADE_POWER: 10\n POWER_CREEP_SPAWN_COOLDOWN: 3600000 # 1 Hour\n POWER_CREEP_DELETE_COOLDOWN: 3600000\n welcomeText: |\n Welcome
\n Powered by screepsmod-admin-utils
\n statsToken: ...splusToken... # This enables submitting stats to S+ Grafana. Note: shardName MUST be set\n # Default false\n gclToCPU: true\n # Default 300\n maxCPU: 100 \n # Default 20\n baseCPU: 20 \n # Default 10\n stepCPU: 10\n```\n\n:bulb: All fields above are optional\n\n:bulb: To specify the `map` field, [screepsmod-mongo](https://github.com/ScreepsMods/screepsmod-mongo) must be installed first.\n\n- For valid `map` value, visit [maps.screepspl.us](https://maps.screepspl.us/), or execute `curl https://maps.screepspl.us/maps/index.json` for source data.\n- Each map has its `ID` and optional `Width` and `Height`.\n - Specified map ID: screeps will import the corresponding map.\n - Set as `random` (or `random_WxH`, e.g `random_1x2`): screeps will import a random map (or a random map with the specified width and height).\n\n:bulb: After staring up the server, modifying the values of the `serverConfig` field will be reloaded into the server.\n\n\n\n****\n\nAny configurations written in the `serverConfig` section will override the configurations used by Screeps in the `.screepsrc` file. Here's an example of the same configurations in the `.screepsrc` and `screepsmod-mongo`:\n\n* in `.screepsrc`:\n\n ```ini\n ;The port number on which the game server should listen.\n port = 21025\n ;The hostname on which the game server should listen.\n host = 0.0.0.0\n ;The server password which should be provided on user sign in.\n password =\n \n ;The following configuration is for screepsmod-mongo if installed\n [mongo]\n host = mongo\n port = 27017\n database = screeps\n \n [redis]\n host = redis\n port = 6379\n ```\n\n* in `config.yaml`:\n\n ```yaml\n serverConfig:\n \tport: 21025\n \thost: \"0.0.0.0\"\n \tpassword: \"\"\n \tmongo:\n \t\thost: mongo\n \t\tport: 21017\n \t\tdatabase: screeps\n \tredis:\n \t\thost: redis\n \t\tport: 6379\n ```\n\n:bulb: Specific principle: `ini` files and `yaml` files are both in key-value pair format, and thus can be converted to each other. In an `ini` file, square brackets `[]` are used to indicate a section, which can contain any number of key-value pairs, corresponding to a nested object in `yaml`, for example: the section `[mongo]` corresponds to the `serverConfig.mongo` object.\n\n[↑ back to top]
\n\n### This Project\n\nThis project is based on screeps-launcher, not aiming to develop a new launcher, but to provide two preset launch methods for players who want to set up a runnable screeps private server in a short time; and to provide some convenient CLI commands for users running services with docker.\n\nPlayers need to first use `screeps-deploy-wizard init` or the abbreviation `sdw init`, and follow the interactive command line to configure some necessary options. The CLI will generate the necessary files for starting the screeps server based on the selected preset.\n\nFor players using the Primary preset, they can directly use the `config.yaml` generated by this CLI, refer to the instructions in [screeps-launcher/Usage](https://github.com/screepers/screeps-launcher?tab=readme-ov-file#usage), and use the `screeps-launcher` command to start the server. (You need to download a release from the [Releases](https://github.com/screepers/screeps-launcher/releases) page of screeps-launcher first)\n\nFor players using the Advanced preset, the screeps-server, mongo, and redis containers will run simultaneously, and docker compose will be used for unified management. Players can use the commands provided by `sdw` to simplify service management, or use docker commands for more fine-grained operations.\n\n[↑ back to top]
\n\n","readmeFilename":"README.md"}