zyephoenix / towny Goto Github PK

I'm LlmDl, the third lead developer of Towny. I have been managing the Towny project since 2014 and the release of Minecraft 1.8. Prior to me there was the original creator: Shadeness (active 2010-2011,) and the second developer: ElgarL (active 2011-2014.)

I am helped out by the TownyAdvanced team: Articdive, FlagCourier, Warrior and a few other private members. Being open-source Towny has a large list of Contributors who have helped improve the code base over the years as well.

Towny is one of the oldest still-in-development plugins for Minecraft. Shadeness created Towny for the now-defunct server platform called hMod. Shadeness ported Towny to Bukkit and left the project shortly afterwards, returning later to add EnemyWar or as it became known: FlagWar. Towny is now over 10 years old!

Go check out some of the features Towny has and see why it's still popular for yourself.

• Latest Release supports MC 1.16.* & 1.17.* & 1.18.* & 1.19.*.
• Latest Pre-Release supports MC 1.16.* & 1.17.* & 1.18.* & 1.19.*.

Now that all Release builds and Development builds are being made available here on github's Releases tab I am recommending that server admins "watch" Towny on github. Just click the watch button in the upper right and select "Custom > Releases".

Alternatively, if you watch the resource on Spigot you will be notified on that website when a new Release version is out.

The documentation found on the Towny Wiki is updated every time a Release version of Towny is put out. If you are using a development build it is expected that you have read the changelog for any important changes since the previous Release build.

Some important pages to look over:

• Installing Towny
• How Towny Works

Here on GitHub's Issue Tracker you can file bug reports, feature requests, or just ask general questions.

If you still need help, join us on the Discord server, where you can find cutting edge updates and discussion on the development of the plugin.

If you want to support the developer consider becoming a Sponsor.

Courtesy of Major_Graft, we have a new series of Tutorial Videos available on the Towny website and YouTube.

If you'd like to contribute to the Towny code, see the CONTRIBUTING.md.

If you'd like to help translating Towny into the available languages or add entirely new languages, we're on Crowdin!

Towny is licensed under the Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported (CC BY-NC-ND 3.0) License

We don't object to you making your own forks and builds but we do object to people being selfish, which is why we specify No Derivative Works. If you want to modify the code to add some nice feature the least you can do is ask and submit a pull request to allow everyone to benefit from it.

Developers who wish to use the Towny API in their plugins may read the following instructions on adding Towny via a Maven pom.xml.

If you would like to build from a specific branch yourself, you can do so with either Apache Ant or Apache Maven, depending on the age of the branch.

For building, open your terminal / command prompt and navigate to the Towny Directory (either extracted, or cloned).

• Maven

  • Run mvn clean package to generate the plugin in the target directory, within the Towny folder.

• Ant (Deprecated)

  • For older branches using the Ant build system, the main command to use would be: ant clean jar. This command will exit the Towny directory, creating a lib folder alongside it. A Towny.jar file will be generated and placed within there.
  • Note: As Ant is being deprecated, older branches may eventually not be able to be built against without modification of the build.xml file. We leave no guarantee that the file repo providing the dependencies will stay up.