Quick Start

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

Rust

To run Pumpkin with Rust, ensure you have Rust installed.

shell

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

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

NOTE

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

shell

cargo run --release

Optional: If you want to use your CPU features, you can set the target-cpu=native Rust compiler flag.

shell

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

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:

shell

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.

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

shell

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

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

Specs: