Skip to content
This repository has been archived by the owner on Feb 3, 2024. It is now read-only.

Management plugin for The Wooden Spoon Minecraft Server. You can find their website @ https://tws.gg/

License

Notifications You must be signed in to change notification settings

kylejuliandev/tws.management

Repository files navigation

TWSManagement

General

Plugin to provide management functionalities for Minecraft servers. Specifically, this plugin was created for the The Wooden Spoon Minecraft Server. You can check out their website @ tws.gg.

Features

This plugin has a variety of bespoke features intended for the use of TWS Server. The features are listed below:

  • Ability to go afk
    • Players automatically go afk after not triggering certain events config.json)
    • Player can manually go afk through:
      • /afk
    • AFK players are shown as AFK in the tab menu (if you have the TAB plugin installed, see below)
  • Ability to kick an afk player after a configurable config.json of time
  • Ability to add Players to an AFK Kick exempt list, stored in a local SQLite database - The in-game commands for this feature are listed below:
    • /afk exempt list
    • /afk exempt add <PlayerName>
    • /afk exempt remove <PlayerName>
    • /afk exempt clear
  • Automatically set night to day if the following conditions are met:
    • It is currently night time (in game)
    • All remaining players are AFK
    • At-least one player is asleep. The act of getting in to a Minecraft Bed triggers this code
    • Any players not AFK must be other worlds, such as the Nether
  • Add a Heads up Display (HUD) which displays a players coordinates and world time
    • To activate the HUD players can use the following command:
      • /hud
    • Players who have enabled the HUD are stored in a local SQLite database
  • Add automatic unwhitelisting of players who are inactive for a configurable config.json amount of days and hours.
    • If a player is inactive for more than the combined duration (days + hours) they will be removed from the server whitelist
    • If the player is due to be unwhitelisted, they can be made exempt through granting them a permission node tws.exempt.auto or using the in-game commands (see below).
  • To add Players to the exempt list for the auto unwhitelisting, you can use the in-game commands below:
    • /exe list
    • /exe add <PlayerName>
    • /exe remove <PlayerName>
    • /exe clear

This plugin maintains a local SQLite database which persists information used by some of the provided features. This is found under: /plugins/tws.management/tws-local.db.

Running the Plugin

This plugin runs on Minecraft Purpur 1.20.1. You can download the latest version of the plugin jar through navigating the Packages section of this github repository, or using the following link packages.

Requirements

The following symbols are used to indicate if a dependency (plugin also running on the server) is essential or not:

  • ❗ Essential
  • ❓ Not Essential

To run this plugin you must have the following dependencies also running on your Minecraft Server:

  • TAB - Displays the AFK suffix tag next to your name, in the tab leaderboard.
  • LuckPerms - Used when checking if players have a permission node when automatically unwhitelisting.