Towny Advanced Documentation

Towny uses a dual-layer approach to determine which language to display:

1. Player-driven: By default, Towny detects the locale set in a player's Minecraft client settings. If the player's language is supported on the Towny Crowdin page, Towny will automatically display messages in that language.
2. Admin-driven (Fallback/Console): The server administrator can set a global default language in config.yml using the language: setting. This language is used for console messages and serves as the fallback for players whose language is not natively supported by a translation file.

Developers can integrate the Towny API into their own Minecraft plugins using Maven. To get started, add Towny as a dependency in your pom.xml via JitPack. Detailed instructions for IDE setup and a comprehensive guide to the available API can be found in the official Towny Wiki.

<!-- Dependency via JitPack -->
<dependency>
    <groupId>com.github.TownyAdvanced</groupId>
    <artifactId>Towny</artifactId>
    <version>LATEST_VERSION</version>
    <scope>provided</scope>
</dependency>

Documentation

• Towny Wiki: The primary source for installation guides, FAQs, and core mechanics (How Towny Works).
• Changelog: Essential for pre-release users to understand changes since the last release.

Support

• Discord: Join the Discord server for support, add-on plugin discussions, and plugin development.
• GitHub Issues: Use the Issue Tracker for bug reports and feature requests.
• Sponsorship: Note that hands-on support from the lead developer (LlmDl) on Discord is generally reserved for sponsors.

You can build Towny from a specific branch using either Apache Maven or Apache Ant.

Using Maven (Recommended)

Run the following command in the Towny directory to generate the plugin in the target directory:

mvn clean package

Using Ant (Deprecated)

For older branches, use the following command. Note that this command will create a lib folder outside the Towny directory containing the generated Towny.jar:

ant clean jar

To receive notifications about new releases, you can:

1. GitHub: 'Watch' the repository and select Custom > Releases.
2. SpigotMC: 'Watch' the Towny resource on the SpigotMC website.

To apply custom translations or changes (like modifying the Towny prefix or status screen colors) globally across all languages, use the global.yml file located in the towny\settings\lang\override\ folder. Any strings added to this file will override the default strings in every language.

File path: towny\settings\lang\override\global.yml

If you want to provide a custom translation for a specific language or translate Towny locally, follow these steps:

1. Locate the desired language file in the towny\settings\lang\reference\ folder.
2. Move (do not just copy) the file into the towny\settings\lang\override\ folder.
3. Edit the file in the override folder.

CRITICAL WARNING: Never edit files directly in the towny\settings\lang\reference\ folder. Towny will overwrite these files during the loading process, and all your changes will be lost.

1. Move file from: towny\settings\lang\reference\
2. To: towny\settings\lang\override\

To set the default language for console messages and unsupported player locales, edit the config.yml file and modify the language: setting.

language: [YOUR_LANGUAGE_CODE]

A nation leader can remove towns from their nation using the /nation kick [TOWN_NAMES] command.

Constraints:

• The capital town of a nation cannot be kicked.
• If the command is cancelled by a NationPreTownKickEvent, the town remains in the nation.
• Once kicked, the town is no longer part of the nation and becomes an independent town (or follows the rules for towns without nations).

/nation kick [TOWN_NAME]