Oliver/Phantom-Ink-Online
0
0
Fork 0
Code Issues Activity

Update clarity of the server README

Browse source
This commit is contained in:
Oliver-Akins 2021-01-11 17:17:40 -07:00
parent 5ee439a6e7
commit 9ae1568bea
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
server/README.md
View file

@ -2,17 +2,17 @@
1. `cd` into this `server` directory. 1. `cd` into this `server` directory.
2. Run `pnpm install` to install all of the required dependencies. 2. Run `pnpm install` to install all of the required dependencies.
3. Create a copy of the `template.toml` file, and name it `server.toml`. 3. Create a copy of the `template.toml` file, and name it `server.toml`.
4. Edit the `server.toml` file to adjust the 4. Edit the `server.toml` file to adjust the server and game settings.
5. Run `tsc` to compile the TypeScript into Javascript. This should create a 5. Run `tsc` to compile the TypeScript into Javascript. This should create a
`dist` directory. `dist` directory.
## Using systemd to manage the server: (Not currently implemented) ## Using systemd to manage the server:
This app comes with a `ghost-writer.service` file which is already set up to This app comes with a `ghost-writer.service` file which is already set up to
manage the server, it just requires a little bit of additional setup. If you manage the server, it just requires a little bit of additional setup. If you
change any of the symlinking in the steps below, it is your responsibility to change any of the symlinking in the steps below, it is your responsibility to
figure it out, I will not guarantee support for people who attempt to modify figure it out, I will not guarantee support for people who attempt to modify
the service file. the service file beyond the steps below.
6. Create a symlink named `server` in the server root (`/`) pointing to the 6. Create a symlink named `server` in the server root (`/`) pointing to the
server folder in the Ghost Writer git repository. server folder in the Ghost Writer git repository.