https://github.com/Protonull/Extenstom

Barebones extension-based Minestom server
https://github.com/Protonull/Extenstom

minecraft minecraft-server minestom minestom-implementation minestom-server

Last synced: 12 days ago
JSON representation

Barebones extension-based Minestom server

• Host: GitHub
• URL: https://github.com/Protonull/Extenstom
• Owner: Protonull
• License: mit
• Created: 2021-05-13T01:17:30.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-05-01T13:02:19.000Z (2 months ago)
• Last Synced: 2024-06-14T18:00:43.089Z (20 days ago)
• Topics: minecraft, minecraft-server, minestom, minestom-implementation, minestom-server
• Language: Java
• Homepage:
• Size: 148 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:

Lists

• awesome-minestom - BasicMinestomServer - Barebones extension-only server jar. (Implementations)

README

        
# BasicMinestomServer

[![GitHub](https://img.shields.io/github/license/Protonull/BasicMinestomServer?style=flat-square&color=b2204c)](https://github.com/Protonull/BasicMinestomServer/blob/master/LICENSE)

[![GitHub Repo stars](https://img.shields.io/github/stars/Protonull/BasicMinestomServer?style=flat-square)](https://github.com/Protonull/BasicMinestomServer/stargazers)

BasicMinestomServer is an ***EXTREMELY*** basic [Minestom](https://github.com/Minestom/Minestom) server in that it produces a jar that'll run... and that's it.

## Install

You can either use the provided latest build [here](https://github.com/Protonull/BasicMinestomServer/releases/tag/latest) or you can compile it yourself with JDK 17 by doing:

```shell

git clone https://github.com/Protonull/BasicMinestomServer.git

cd BasicMinestomServer

./gradlew build

```

The resulting jar will be located at: `build/libs/BasicMinestomServer-.jar`

## Usage

You'll need Java 17 or above to run BasicMinestomServer. You need only execute it like so:

```shell

java -jar BasicMinestomServer-.jar

```

You can also set the `host` and `port` values like so (otherwise they'll default to `localhost` and `25565` respectively):

```shell

java -jar -Dhost="localhost" -Dport=25565 BasicMinestomServer-.jar

```

## Extending

Any and all custom behaviour should be handled by [extensions](https://wiki.minestom.net/expansion/extensions). For example,

[StomCleanly](https://github.com/Protonull/StomCleanly) introduces a `/stop` command.

```java

package exmple.extension;

import net.minestom.server.MinecraftServer;

import net.minestom.server.extensions.Extension;

import net.minestom.server.extras.bungee.BungeeCordProxy;

public class ExampleExtension extends Extension {

    // This method should be used for things that ought to be done as soon as possible.

    @Override

    public void preInitialize() {

        MinecraftServer.setBrandName("BestServerEverMC");

        MinecraftServer.setTerminalEnabled(false);

    }

    // This method is for other things that occur prior to server start.

    @Override

    public void initialize() {

        BungeeCordProxy.enable();

    }

    // This method is for anything you want to do after the server has started.

    @Override

    public void postInitialize() {

    }

}

```