forkprince / husktowns Goto Github PK

Spigot — Setup — Docs — Issues

HuskTowns is a simple and elegant proxy-compatible Towny-style protection plugin for Spigot-based Minecraft servers. Let players form towns, claim chunks and carve out a thriving community. Built into HuskTowns is a robust and beautiful chat interface with a plethora of admin tools and config options to let you tailor the plugin to your needs.

All of this is supported on both standalone setups and across a network of proxied servers—with support for a good range of add-ons to further enhance your experience.

⭐ Works cross-server — Let players seamlessly manage their towns, claims and teleport to their town spawn across your proxy network!

⭐ Super intuitive — Users will pick up how to use it right away! Make a town with /town create and claim a chunk with /town claim to get started.

⭐ Quick and beautiful menus — Sometimes, simple is better. No monolithic chest GUIs—instead, robust and beautiful interactive chat menus.

⭐ Great admin features — Manage the towns on your server and easily make admin claims. Comes with built-in support for Dynmap, BlueMap, Plan, LuckPerms, HuskHomes & more!

⭐ Easy to configure — Players can fine-tune town flags and access settings in-game, and admins can easily configure roles and levels through a simple config structure.

⭐ Extensible API & open-source — Need more? Extend the plugin with the Developer API. Or, submit a pull request through our code bounty system!

Ready? Let's head down town!

Requires Java 16+ and a Minecraft 1.16.5 Spigot-based server. A MySQL database and (optionally) Redis are also needed if you wish to run the plugin across multiple servers on a proxy network.

1. Place the plugin jar file in the /plugins/ directory of each Spigot server you want to install it on.
2. Start, then stop every server to let HuskTowns generate the config file.
3. Navigate to the HuskTowns config file on each server (~/plugins/HuskTowns/config.yml)
4. Configure the plugin to your liking. If you are running HuskTowns across multiple servers, enable cross_server mode and fill in your MySQL credentials, remembering to change the database type to MYSQL as well.
5. You can also modify the level requirements in ~/levels.yml, the default town rule settings in ~/rules.yml and the town roles in ~/roles.yml
6. Start every server again and HuskTowns should have completed installation!

To build HuskTowns, simply run the following in the root of the repository:

./gradlew clean build

HuskTowns is a premium resource. This source code is provided as reference only for those who have purchased the resource from an official source.

• License

A code bounty program is in place for HuskTowns, where developers making significant code contributions to HuskTowns may be entitled to a license at my discretion to use HuskTowns in commercial contexts without having to purchase the resource. Please read the information for contributors in the LICENSE file before submitting a pull request.

Translations of the plugin locales are welcome to help make the plugin more accessible. Please submit a pull request with your translations as a .yml file. (More info…)

• Locales Directory
• English Locales

• Docs — Read the plugin documentation!
• Spigot — View the Spigot resource page (Also: Polymart, Songoda)
• Issues — File a bug report or feature request
• Discord — Get help, ask questions (Proof of purchase required)
• bStats — View plugin metrics

© William278, 2023. All rights reserved.