https://github.com/protonull/pistomqueue

PistonQueue for Minestom
https://github.com/protonull/pistomqueue

minecraft minestom minestom-server pistonqueue

Last synced: 2 months ago
JSON representation

PistonQueue for Minestom

• Host: GitHub
• URL: https://github.com/protonull/pistomqueue
• Owner: Protonull
• License: apache-2.0
• Created: 2022-12-31T12:35:43.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2024-09-17T20:47:42.000Z (8 months ago)
• Last Synced: 2025-01-25T18:13:22.711Z (4 months ago)
• Topics: minecraft, minestom, minestom-server, pistonqueue
• Language: Java
• Homepage:
• Size: 146 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: .github/README.md

Awesome Lists containing this project

README

        
# PistomQueue

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

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

PistomQueue is a standalone implementation of [PistonQueue](https://github.com/AlexProgrammerDE/PistonQueue) for

[Minestom](https://github.com/Minestom/Minestom). Since the queue login is handled by the proxy, the server is largely

just there to host the players while they wait: they'll be whisked off the server again when a slot opens. This is a

great use case for [Minestom](https://github.com/Minestom/Minestom).

## Install

You can either use the provided latest build [here](https://github.com/Protonull/PistomQueue/releases/tag/latest) or you

can compile it yourself with JDK 21 by doing:

```shell

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

cd PistomQueue

./gradlew build

```

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

## Usage

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

```shell

java -jar PistomQueue-.jar

```

## Options

PistomQueue permits the following options:

```shell

# Don't try to copy paste this script, the comments (and empty lines) break it.

java -jar \

    

    # The server's hostname

    -Dhost="0.0.0.0" \

    

    # The server's port

    -Dport=25565 \

    

    # Whether players should be hidden from one another

    -DhidePlayers=false \

    

    # Whether chatting should be disabled

    -DdisableChat=false \

    

    # Whether to play a chime to players when they're close to the front of the queue

    -DplayXP=true \

    

    # The names of those, separated by commas, who should be exempt from restrictions

    -DexemptedPlayers="FirstPlayer,SecondPlayer,__Third-Player__" \

    

    # What proxy to use, if any:

    # - NONE

    # - BUNGEE

    # - VELOCITY

    -Dproxy="NONE" \

    

    # (OPTIONAL) Your Bungee tokens, assuming you've specified Bungee as your proxy, separated by commas

    -DbungeeTokens="Token1,Token2" \

    

    # (CONDITIONAL) Your Velocity secret, which is required assuming you've specified Velocity as your proxy

    -DvelocitySecret="YourSecret"

```

## Testing

This repo comes with a test-setup that you can run:

- `sh run/proxy/StartProxy.sh`: This will start a Velocity proxy with [PistonQueue](https://github.com/AlexProgrammerDE/PistonQueue)

  on port 25565.

- `sh run/server/StartServer.sh`: This will start a PaperMC target server on port 25570. You accept [Minecraft's EULA](https://www.minecraft.net/en-us/eula)

  by running this script.

- `./gradlew run`: This will start PistomQueue on port 25571.