fix (docs): update command-line options used in documentation examples

develop
Kevin Turner 2020-12-19 17:18:20 -08:00
parent 59f8ef54af
commit 5942300de2
1 changed files with 4 additions and 4 deletions

View File

@ -4,7 +4,7 @@ For more details on how to play Terasology, keep reading!
If you hit issues look for the game log files. By default they go into your user home directory, for instance `C:\Users\[username]\Saved Games\Terasology\logs` on Windows.
You can run the game with `-homedir` to instead store all game data in the directory you ran from. Or just use the [Launcher](https://github.com/MovingBlocks/TerasologyLauncher/releases) - it handles all that stuff!
You can run the game with `--homedir=.` to instead store all game data in the directory you ran from. Or just use the [Launcher](https://github.com/MovingBlocks/TerasologyLauncher/releases) - it handles all that stuff!
Report issues on [GitHub](https://github.com/MovingBlocks/Terasology/issues/new) or ask on [Discord](https://discord.com/channels/270264625419911192/713903952764207164).
@ -97,9 +97,9 @@ Unlike in single player in a multiplayer setting permissions are enforced for co
You can also run a headless server, but need to do so via command line, for example with a downloaded version:
`java -jar libs/Terasology.jar -headless -homedir=server`
`java -jar libs/Terasology.jar --headless --homedir=server`
This will launch the server and store game files in the "server" subdir at the place you launch from (otherwise it'll use the default path, which could clash with a client on the same system). You can add `-serverPort=#####` to run on a different port than default 25777.
This will launch the server and store game files in the "server" subdir at the place you launch from (otherwise it'll use the default path, which could clash with a client on the same system). You can add `--server-port=#####` to run on a different port than default 25777.
In this case *there is no default player with rights beyond "chat"*. You need to gain admin powers yourself using the `oneTimeAuthorizationKey` that generates in the server's `config.cfg`. This gives you all permission types except "debug"
@ -113,7 +113,7 @@ With *server* rights you can terminate the server gracefully via `shutdownServer
Finally to get modules configured for a headless server you either have to manually edit in a list of modules to the `defaultModSelection` section, and `defaultGenerator` for your chosen world, then delete the `saves` dir for the server and restart it. Start a single player world and look at the `config.cfg` that generates for hints.
It is also possible to provide a configuration file which overrides the default configuration on startup. This file can be passed using the `-overrideDefaultConfig=<pathToFile>`. Settings from this file will be copied to the generated `config.cfg`. After that changes in the `config.cfg` have priority, so further modifications in the override file will not modify the server values. It not required to pass an entire configuration file. A typical example would be:
It is also possible to provide a configuration file which overrides the default configuration on startup. This file can be passed using the `--override-default-config=<pathToFile>`. Settings from this file will be copied to the generated `config.cfg`. After that changes in the `config.cfg` have priority, so further modifications in the override file will not modify the server values. It not required to pass an entire configuration file. A typical example would be:
```
{