If you are updating from <v0.2.1, please read the update log. Breaking changes are introduced in v0.2.1!




TownyQueue(TQ) is a light-weight and simple add-on to the native Towny. In the original Towny, the mayor and the players looking for a town to join must be online at the same time to complete the town joining process. This might work for some servers, and it might not for others.

TownyQueue creates a queue(duh) for which players can join, and mayors can invite off from. This then introduces an async mechanism to the Towny joining process. Furthermore, this prevents chat spamming for players who are looking for a town to join and mayors who are looking for new members.

Wiki: Home · Wiki · NatureCraft Dev / TownyQueue · GitLab
Issue Tracker: Issues · NatureCraft Dev / TownyQueue · GitLab
Discord: https://discord.gg/5HfzxpUksS

Dependencies: Towny, PlaceholderAPI(optional)

Tested Platforms: Spigot, Paper, and other Spigot-Derivs


Bumping
The system offers players the ability to "bump" themselves on the queue, so that they will be ranked higher than other players, so they have a better chance of getting picked by the mayors. Currently, you can only bump yourself every 30 minutes. A config option to customize this is coming soon.

Preferred Town
When a player joins the queue, they can choose if they prefer to join a certain town. When they have a preferred town, their name will be highlighted when a mayor executes the /tq list command.

Ranking System
Currently, the queue is first sorted by bump count from highest to lowest. Then, in a segment of 5, that segment is sorted by the time when the players join the queue, from the oldest to the most recent. In summary, players with higher bump counts are ranked above those with lower counts, and players who are already in the queue for a longer time is ranked higher than those who joined recently.

• /tq join [town_name]: command for a player to join the townyqueue. You can add your preferred town name in the end for the mayor of that town to notice that you are interested in joining his/her town.

• /tq leave: obviously, the command to withdraw yourself from the queue for whatever reason (you will be automatically removed from the queue if a mayor accepts you through native towny)

• /tq changeTown: the command to change your preferred town

• /tq invite <playerName>: the command used by town mayors to invite people from the queue. This command is only accessible by mayors.

• /tq bump: the command to bump yourself in the queue. For what that means, please refer to wiki.

• /tq list: list the current queue.

• /tq listOnlineMayor: list all the mayors online

• townyqueue_totalcount: the total number of players in the queue at the moment.