AsgardEternal/SquadJS
1
0
Fork 0
mirror of https://github.com/AsgardEternal/SquadJS.git synced 2024-09-28 06:04:23 -05:00
Code Issues Packages Projects Releases Wiki Activity

Serve config example as config.example.json

Browse Source
This commit is contained in:
Matz Reckeweg 2023-02-04 15:04:04 +01:00
parent 8d59d6b329
commit 7cf9601485
6 changed files with 16 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -12,3 +12,7 @@ yarn.lock
# IDEs
.idea/
.vs/
config.json
config.*.json
!config.example.json

2
.husky/pre-commit
View File

@ -4,4 +4,4 @@
yarn run lint-staged
yarn run build-all
git add README.md
git add config.json
git add config.example.json

7
README.md
View File

@ -37,7 +37,7 @@ SquadJS relies on being able to access the Squad server log directory in order t
1. [Download SquadJS](https://github.com/Team-Silver-Sphere/SquadJS/releases/latest) and unzip the download.
2. Open the unzipped folder in your terminal.
3. Install the dependencies by running `yarn install` in your terminal. Due to the use of Yarn Workspaces it is important to use `yarn install` and **not** `npm install` as this will not work and will break stuff.
4. Configure the `config.json` file. See below for more details.
4. Create a new configuration. See [here](#configuring-squadjs) for more details.
5. Start SquadJS by running `node index.js` in your terminal.
**Note** - If you are interested in testing versions of SquadJS not yet released please download/clone the `master` branch. Please also see [here](#versions-and-releases) for more information on our versions and release procedures.
@ -45,7 +45,10 @@ SquadJS relies on being able to access the Squad server log directory in order t
<br>
## **Configuring SquadJS**
SquadJS can be configured via a JSON configuration file which, by default, is located in the SquadJS and is named [config.json](./config.json).
SquadJS can be configured via a JSON configuration file. The default location for the config is [config.json](./config.json). This file has to be created manualy.
`config.example.json` can be used as template for new configurations.
You can maintain multiple configs using this naming scheme: `config.<configname>.json`. This naming scheme is useful for multiple servers or [config merging](#merged-configurations).
The config file needs to be valid JSON syntax. If an error is thrown saying the config cannot be parsed then try putting the config into a JSON syntax checker (there's plenty to choose from that can be found via Google).

0
config.json → config.example.json
View File

2
squad-server/factory.js
View File

@ -201,7 +201,7 @@ export default class SquadServerFactory {
}
static async buildConfigFile() {
const configPath = path.resolve(__dirname, '../config.json');
const configPath = path.resolve(__dirname, '../config.example.json');
const config = await SquadServerFactory.buildConfig();
const configString = JSON.stringify(config, null, 2);

7
squad-server/templates/readme-template.md
View File

@ -37,7 +37,7 @@ SquadJS relies on being able to access the Squad server log directory in order t
1. [Download SquadJS](https://github.com/Team-Silver-Sphere/SquadJS/releases/latest) and unzip the download.
2. Open the unzipped folder in your terminal.
3. Install the dependencies by running `yarn install` in your terminal. Due to the use of Yarn Workspaces it is important to use `yarn install` and **not** `npm install` as this will not work and will break stuff.
4. Configure the `config.json` file. See below for more details.
4. Create a new configuration. See [here](#configuring-squadjs) for more details.
5. Start SquadJS by running `node index.js` in your terminal.
**Note** - If you are interested in testing versions of SquadJS not yet released please download/clone the `master` branch. Please also see [here](#versions-and-releases) for more information on our versions and release procedures.
@ -45,7 +45,10 @@ SquadJS relies on being able to access the Squad server log directory in order t
<br>
## **Configuring SquadJS**
SquadJS can be configured via a JSON configuration file which, by default, is located in the SquadJS and is named [config.json](./config.json).
SquadJS can be configured via a JSON configuration file. The default location for the config is [config.json](./config.json). This file has to be created manualy.
`config.example.json` can be used as template for new configurations.
You can maintain multiple configs using this naming scheme: `config.<configname>.json`. This naming scheme is useful for multiple servers or [config merging](#merged-configurations).
The config file needs to be valid JSON syntax. If an error is thrown saying the config cannot be parsed then try putting the config into a JSON syntax checker (there's plenty to choose from that can be found via Google).