Skip to content

Commit

Permalink
Apply minor fixes and improvements to docs (#10)
Browse files Browse the repository at this point in the history
* Fix relative paths to main README file

* Fix headings sizes

* Add note welcoming contributions

* Reorder topics for better steps sequence
  • Loading branch information
mathielo authored Aug 6, 2018
1 parent b070016 commit d22aa44
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 27 deletions.
42 changes: 23 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ These are the minimum required steps to have a server running:
Enhance your server by customizing it to your liking!

* Customize your server
* [World Settings](#the-world) (World Size, Seasons, Difficulty, etc)
* [Tweak server settings](#the-server) (game mode, max players, Steam Group, description, etc.)
* [World Settings](#the-world) (World Size, Seasons, Difficulty, etc)
* [Install Mods](DSTClusterConfig/mods)
* [Set Admins, Bans and Whitelisted Players](docs/AdminBanWhitelist.md)
* How to optimize your [DST Server Performance](docs/ServerPerformance.md)
Expand Down Expand Up @@ -62,8 +62,6 @@ Follow the official docs to install Docker on Linux. At first glance it might se
* Enable your user to manage `docker` without the need of `sudo`
* Configure Docker to start on boot

---

### Mac OS / Windows

You only need the [Docker desktop standalone](https://docs.docker.com/engine/installation/#desktop) as it has everything you need, no extra steps required.
Expand Down Expand Up @@ -98,7 +96,9 @@ You should now have everything you **need** to start playing! See the full docs

Keep on reading to learn how to :point_down: [customize the server](#customizing-the-server--world) :point_down: and [install mods](#managing-mods) to your liking!

# Customizing the Server / World
---

# Customize the Server and World

The files listed below are the ones you'll likely be tweaking to customize your server and world to your likes.

Expand All @@ -119,42 +119,46 @@ DSTClusterConfig/
whitelist.txt
```

# The World
## The Server

Determines the settings for world generation for each shard, respectively:
* [DSTClusterConfig/cluster.ini](./DSTClusterConfig/cluster.ini)

* [DSTClusterConfig/Master/leveldataoverride.lua](./DSTClusterConfig/Master/leveldataoverride.lua)
* [DSTClusterConfig/Caves/leveldataoverride.lua](./DSTClusterConfig/Caves/leveldataoverride.lua)
This file holds server attributes, such as `max_players`, `pause_when_empty`, `cluster_intention` - and [many others :link:](https://forums.kleientertainment.com/topic/64552-dedicated-server-settings-guide/).

You may tweak them as much as you like, granted that **the cave one** always have these defined:
> :bulb: On your **first setup** it's important to change at least the [`cluster_name`](./DSTClusterConfig/cluster.ini#L27) and [`cluster_password`](./DSTClusterConfig/cluster.ini#L29) to be able to identify and join your sever from the game's server list.
id="DST_CAVE"
location="Cave"
> :cop: Please handle with care. There are sections where `[ CHANGE THIS ]` denotes places you **should** change. There are also smaller secitions which **should not be touched** as it might compromise the communication between Master <-> Caves shards.
# The Server
By default the server will autosave once every game day (`autosaver_enabled = true`).

* [DSTClusterConfig/cluster.ini](./DSTClusterConfig/cluster.ini)
## The World

This file holds server attributes, such as `max_players`, `pause_when_empty`, `cluster_intention` - and [many others :link:](https://forums.kleientertainment.com/topic/64552-dedicated-server-settings-guide/).
Determines the settings for world generation for each shard, respectively:

> :bulb: On your **first setup** it's important you change at least the [`cluster_name`](./DSTClusterConfig/cluster.ini#L27) and [`cluster_password`](./DSTClusterConfig/cluster.ini#L29) to be able to identify and join your sever from the game's server list.
* [DSTClusterConfig/Master/leveldataoverride.lua](./DSTClusterConfig/Master/leveldataoverride.lua)
* [DSTClusterConfig/Caves/leveldataoverride.lua](./DSTClusterConfig/Caves/leveldataoverride.lua)

> :cop: Please handle with care. There are sections where `[ CHANGE THIS ]` denotes places you **should** change. There are also smaller secitions which **should not be touched** as it might compromise the communication between Master <-> Caves shards.
You may tweak them as much as you like, granted that **the cave one** always have these defined:

By default the server will autosave once every game day (`autosaver_enabled = true`).
id="DST_CAVE"
location="Cave"

# Mods
## Mods

Check the [detailed instructions](./DSTClusterConfig/mods) on how to install, configure and enable mods. :alien:

# Admins, Bans and Whitelists
## Admins, Bans and Whitelists

If you know what you're after, the `(admin|block|white)list.txt` files can be found within the [`DSTClusterConfig/`](./DSTClusterConfig) folder.

You can find detailed information and a complete guide in the [Setting Admins, Bans and Whitelisted Players](./docs/AdminBanWhitelist.md) docs.

---

# Contributing

Contributions and feedback are always welcome! Feel free to open an [issue](/../../issues) or a [pull request](/../../pulls) with improvements!

# References

* [How to setup dedicated server with cave on Linux](http://steamcommunity.com/sharedfiles/filedetails/?id=590565473)
Expand Down
16 changes: 8 additions & 8 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@
These are the minimum required steps to have a server running:

* Prepare the host
* [Install Git](../#prepare-the-host)
* [Install Docker](../#install-docker)
* [Install Git](/../../#prepare-the-host)
* [Install Docker](/../../#install-docker)
* Setup the server
* [Server files](../#prepare-the-dedicated-server) (clone this repository)
* [Generate `cluster_token.txt`](../#generate-cluster_tokentxt)
* [Server files](/../../#prepare-the-dedicated-server) (clone this repository)
* [Generate `cluster_token.txt`](/../../#generate-cluster_tokentxt)
* [Manage the server](./ManagingTheServer.md) (how to start, save and stop)
* [Basic settings setup](../#the-server) (server name, password, etc.)
* [Basic settings setup](/../../#the-server) (server name, password, etc.)

## Optionals

Enhance your server by customizing it to your liking!

* Customize your server
* [World Settings](../#the-world) (World Size, Seasons, Difficulty, etc)
* [Tweak server settings](../#the-server) (game mode, max players, Steam Group, description, etc.)
* [Install Mods](../DSTClusterConfig/mods)
* [Tweak server settings](/../../#the-server) (game mode, max players, Steam Group, description, etc.)
* [World Settings](/../../#the-world) (World Size, Seasons, Difficulty, etc)
* [Install Mods](/../../DSTClusterConfig/mods)
* [Set Admins, Bans and Whitelisted Players](./AdminBanWhitelist.md)
* How to optimize your [DST Server Performance](./ServerPerformance.md)

0 comments on commit d22aa44

Please sign in to comment.