From 4d01ab630bdb26af64d7c768c605fe730547a15f Mon Sep 17 00:00:00 2001 From: Snowiiii Date: Tue, 22 Oct 2024 14:03:34 +0200 Subject: [PATCH] docs: add Test Server --- docs/about/quick-start.md | 18 ++++++++++++++++-- docs/config/basic.md | 9 +++++++++ 2 files changed, 25 insertions(+), 2 deletions(-) diff --git a/docs/about/quick-start.md b/docs/about/quick-start.md index b88036826..74ceff6cb 100644 --- a/docs/about/quick-start.md +++ b/docs/about/quick-start.md @@ -1,9 +1,10 @@ # 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 @@ -11,6 +12,8 @@ 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: @@ -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 \ No newline at end of file diff --git a/docs/config/basic.md b/docs/config/basic.md index 7eda8546c..1703b11d4 100644 --- a/docs/config/basic.md +++ b/docs/config/basic.md @@ -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