strawberry

Strawberry is a custom minecraft survival server implementation.

Strawberry uses Minestom as its core. This implementation is early work in progress, but once it progresses towards a playable state it should provide a vanilla-like yet different experience. For example there could be completely new biomes and dimensions, villages may work differently and so on.

Table of Contents

• Install
• Usage
• API
• Maintainers
• Contributing
• License

Install

You could either just download a release or you compile the server yourself using the following commands under Linux

git clone https://github.com/self-crafted/strawberry.git
cd strawberry
./gradlew build

The server jar will be located at build/libs/Strawberry-<VERSION>.jar.

Note that for compiling you need to use a JDK 17.

Usage

To run the server you need to have a Java 17 runtime installed. Use the following command to start the server for the first time.

java -jar Strawberry-<VERSION>.jar

This generates a start.sh script and a settings file with these default values:

{
  "SERVER_IP": "localhost",
  "SERVER_PORT": 25565,
  "MODE": "OFFLINE", // may be OFFLINE, ONLINE, BUNGEECORD or VELOCITY
  "VELOCITY_SECRET": "",
  "PLAYER_RESTART": false, // make /restart command executable for all players
  "PLAYER_SHUTDOWN": false, // make /shutdown command executable for all players
  "TPS": null, // default 20
  "CHUNK_VIEW_DISTANCE": null, // default 8
  "ENTITY_VIEW_DISTANCE": null, // default 5
  "TERMINAL_DISABLED": "FALSE" // default false
}

You have to restart the server for changes in there to take effect.

Note that this server only supports 1.18.2 clients. To allow other/multiple versions to connect you need to use a proxy with plugins like ViaVersion.

Restarting

Restarting the server calls the ./start.sh script. The generated script will restart the server with no way to access the console. So keep in mind that you will need an extension providing remote access or use tmux/screen in the start.sh to access the console.

API

This server itself does not add some API. But it features Minestom's API so you can use it from within extensions.

Maintainers

@offby0point5

Contributing

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

This project is licensed under the Apache License Version 2.0.