Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/KlainStom/microstom
Minimal minecraft server using minestom.
https://github.com/KlainStom/microstom
minecraft minecraft-server minestom minestom-implementation minestom-server
Last synced: about 1 month ago
JSON representation
Minimal minecraft server using minestom.
- Host: GitHub
- URL: https://github.com/KlainStom/microstom
- Owner: KlainStom
- License: mit
- Created: 2021-08-04T19:18:29.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2023-06-26T18:26:46.000Z (over 1 year ago)
- Last Synced: 2024-08-04T00:13:02.343Z (5 months ago)
- Topics: minecraft, minecraft-server, minestom, minestom-implementation, minestom-server
- Language: Java
- Homepage:
- Size: 219 KB
- Stars: 16
- Watchers: 0
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-minestom - microstom - A lightweight jar with only the smallest of defauts. (Implementations)
README
# microstom
[](https://github.com/RichardLitt/standard-readme)
[](https://github.com/KlainStom/microstom/blob/master/LICENSE)
[](https://github.com/KlainStom/microstom/stargazers)
[](https://github.com/KlainStom/microstom/network/members)
[](https://github.com/KlainStom/microstom/releases/latest)
[](https://github.com/KlainStom/microstom/releases)
Microstom is a minimal minecraft server with [Minestom](https://github.com/Minestom/Minestom) as its core.
Microstom seeks to be a minimal implementation of a Minestom server.
So it should not include any feature that could have been implemented in an extension.
Every piece of content has to be added as extension, (almost) nothing is there by default.
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [API](#api)
- [Maintainers](#maintainers)
- [Contributing](#contributing)
- [License](#license)
## Install
You could either just download a [release](https://github.com/KlainStom/microstom/releases) or you compile the server yourself using the following commands under Linux
```shell
git clone https://github.com/KlainStom/microstom.git
cd microstom
./gradlew build
```
The server jar will be located at `build/libs/Microstom-.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.
```shell
java -jar Microstom-.jar
```
This generates a `start.sh` script and a settings file with these default values:
```json5
{
"SERVER_IP": "localhost",
"SERVER_PORT": 25565,
"MODE": "OFFLINE", // may be OFFLINE, ONLINE, BUNGEECORD or VELOCITY
"VELOCITY_SECRET": "",
"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.19.2 clients on version 6.0.0, 1.18.2 clients on version 5.0.0 and 1.18/1.18.1 on version 4.0.0. 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](https://github.com/Minestom/Minestom) so you can use it from within extensions.
## Maintainers
[@offby0point5](https://github.com/offby0point5)
## Contributing
PRs accepted.
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
## License
This project is licensed under the [MIT License](LICENSE).