Quick Start

Current Status: Pre-release: Currently under development and not yet ready for official release.

Download Pre-Release binaries

You can download pre-built binaries on the Pre-release Download Page

Build from Source (Rust)

To compile Pumpkin, ensure you have Rust installed.

1. Clone the repository and navigate into the directory:

git clone https://github.com/Pumpkin-MC/Pumpkin.git
cd Pumpkin

2. Optional: If you wish, you can place a Vanilla world into the Pumpkin/ directory. Just name the world folder world.

3. Run:

NOTE

The build process may take a while, due to heavy optimizations for release builds.

cargo run --release

4. Optional: To maximize performance by utilizing your CPU's specific features, you can set the target-cpu=native Rust compiler flag:.

RUSTFLAGS='-C target-cpu=native' cargo run --release

NOTE

To use (to play on) a server that you are self-hosting on the same local system (e.g. using Prism launcher on Linux to login and run/play minecraft and using Pumpkin to host the server) you may need to use "localhost:25565" as the server address through the 'Multiplayer' -> 'Add Server' -> 'Server Address' pathway, though that address is not listed in the terminal's run-server output.

localhost:25565

Docker

IMPORTANT

Docker support is currently experimental.

If you haven't already, you need to install Docker. After installing Docker, you can run the following command to start the server:

docker run --rm \
    -p <exposed_port>:25565  \
    -v <server_data_location>:/pumpkin \
    -it ghcr.io/pumpkin-mc/pumpkin:master

• <exposed_port>: The port you want to connect to Pumpkin with, for example 25565.
• <server_data_location>: The location where you want your server config and data to be stored, for example ./data.

Example

To run Pumpkin on port 25565 and store data in a directory called ./data, you would run the following command:

docker run --rm \
    -p 25565:25565 \
    -v ./data:/pumpkin \
    -it ghcr.io/pumpkin-mc/pumpkin:master

Test Server

Pumpkin has a test server maintained by @kralverde. Its runs on the latest commit of Pumpkin's master branch.

• 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