Skip to content

Commit

Permalink
Make basic docs more consistent (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
suprohub authored Dec 30, 2024
1 parent cfceaf5 commit c923fb0
Showing 1 changed file with 100 additions and 58 deletions.
158 changes: 100 additions & 58 deletions docs/config/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,51 +4,64 @@ Representing `configuration.toml`

## Server Address

The address to bind the server to
The address to bind the server to.

```toml
server_address=0.0.0.0
:::code-group
```toml [configuration.toml] {2}
server_address = "0.0.0.0:25565"
```
:::

## Seed

The seed for world generation
The seed for world generation.

```toml
seed=
:::code-group
```toml [configuration.toml] {2}
seed = ""
```
:::

## Max players

The maximum number of players allowed on the server
The maximum number of players allowed on the server.

```toml
max_players=10000
:::code-group
```toml [configuration.toml] {2}
max_players = 100000
```
:::

## View distance

The maximum view distance for players
The maximum view distance for players.

```toml
view_distance=10
:::code-group
```toml [configuration.toml] {2}
view_distance = 10
```
:::

## Simulation distance

The maximum simulation distance for players
The maximum simulation distance for players.

```toml
simulation_distance=10
:::code-group
```toml [configuration.toml] {2}
simulation_distance = 10
```
:::

## Default difficulty

The default game difficulty
The default game difficulty.

```toml
default_difficulty=Normal
:::code-group
```toml [configuration.toml] {2}
default_difficulty = "Normal"
```
:::


```toml
Peaceful
Expand All @@ -57,81 +70,88 @@ Normal
Hard
```

## Operation permission level

The default permission level for all players.

:::code-group
```toml [configuration.toml] {2}
op_permission_level = 4
```
:::

## Allow nether

Whether the Nether dimension is enabled
Whether the Nether dimension is enabled.

```toml
allow_nether=true
:::code-group
```toml [configuration.toml] {2}
allow_nether = true
```
:::

## Hardcore

Whether the server is in hardcore mode.

```toml
hardcore=true
:::code-group
```toml [configuration.toml] {2}
hardcore = false
```
:::

## Online Mode

Whether online mode is enabled. Requires valid Minecraft accounts
Whether online mode is enabled. Requires valid Minecraft accounts.

```toml
online_mode=true
:::code-group
```toml [configuration.toml] {2}
online_mode = true
```
:::

## Encryption

Whether packet encryption is enabled
Whether packet encryption is enabled.

> [!IMPORTANT]
> Required when online mode is enabled
> Required when online mode is enabled.
```toml
encryption=true
:::code-group
```toml [configuration.toml] {2}
encryption = true
```
:::

## Motd

The server's description displayed on the status screen.

```toml
motd=true
:::code-group
```toml [configuration.toml] {2}
motd = "A Blazing fast Pumpkin Server!"
```
:::

## TPS

The server's Tick rate.

```toml
tps=20.0
```


## Use favicon

Whether to use a server favicon or not
The target server's Tick rate.

```toml
use_favicon=true
```

## Favicon path

The path to the server's favicon

```toml
favicon_path=./icon.png
:::code-group
```toml [configuration.toml] {2}
tps = 20.0
```
:::

## Default gamemode

The default game mode for players
The default game mode for players.

```toml
default_gamemode=Survival
:::code-group
```toml [configuration.toml] {2}
default_gamemode = "Survival"
```
:::

```toml
Undefined
Expand All @@ -143,8 +163,30 @@ Spectator

## IP Scrubbing

Whether to scrub player IPs from logs
Whether to scrub player IPs from logs.

```toml
scrub_ips=true
:::code-group
```toml [configuration.toml] {2}
scrub_ips = true
```
:::

## Use favicon

Whether to use a server favicon or not.

:::code-group
```toml [configuration.toml] {2}
use_favicon = true
```
:::

## Favicon path

The path to the server's favicon.

:::code-group
```toml [configuration.toml] {2}
favicon_path = "icon.png"
```
:::

0 comments on commit c923fb0

Please sign in to comment.