Skip to content

Commit

Permalink
docs: add Test Server
Browse files Browse the repository at this point in the history
  • Loading branch information
Snowiiii committed Oct 22, 2024
1 parent b8b4a8c commit 4d01ab6
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
18 changes: 16 additions & 2 deletions docs/about/quick-start.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# Quick Start

There are currently no release builds, because there was no release :D.
**Current Status:**

To get Pumpkin running, you first have to clone it:
Pre-release: Currently under development and not yet ready for official release.

To get Pumpkin running, you first have to clone it:
```shell
git clone https://github.com/Snowiiii/Pumpkin.git
cd Pumpkin
```

You may also have to [install rust](https://www.rust-lang.org/tools/install) if you don't already have it.

**Optional:**

You can place a vanilla world into the Pumpkin/ directory if you want. Just name the World `world`

Then run:
Expand Down Expand Up @@ -39,3 +42,14 @@ To run it, use the following command:
```shell
docker run --rm -p 25565:25565 -v "./world:/pumpkin/world" pumpkin
```

## Test Server
Pumpkin has a Test server maintained by @kralverde. Its runs on the latest commit of Pumpkin

- **IP:** pumpkin.kralverde.dev

**Specs:**
- OS: Debian GNU/Linux bookworm 12.7 x86_64
- Kernel: Linux 6.1.0-21-cloud-amd64
- CPU: Intel Core (Haswell, no TSX) (2) @ 2.40 GHz
- RAM: 4GB DIMM
9 changes: 9 additions & 0 deletions docs/config/basic.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,15 @@ The server's description displayed on the status screen.
motd=true
```

## TPS

The server's Tick rate.

```toml
tps=20.0
```


## Use favicon

Whether to use a server favicon or not
Expand Down

0 comments on commit 4d01ab6

Please sign in to comment.