Transitioning from the Integrated FlagWar system.
FlagWar has it's own methods for configuration and localization, independent of Towny. Please be advised that we currently only provide an English translation. There will likely be other teething issues, but we are here to help with them when required. See Getting Support if you have issues.
If you would like to help out with development, translations, or other efforts: please see the Developer Resources section.
Metrics / Telemetry
FlagWar, makes use of the bStats metrics library. For an idea of what is collected, you can view
the telemetry reports here.
While we would appreciate it if you were to keep bStats reporting enabled, you can opt-out of sending telemetry
by modifying the bStats config found at yourServer/plugins/bStats/.
FlagWar is one of the first official war systems in the Towny Advanced ecosystem, dating back around 2011. FlagWar works similar to a strategy game, where players can capture regions of other Nations and Towns quickly and with pin-point precision.
I started getting re-involved with Towny’s development, and got some inspiration from users about how to do warring Nations. I also took a gander at some of the mechanics of a similar plugin that did PvP stuff right, Factions. I coded up some threaded tasks that created a huge beacon in the sky overtop the area under attack. The game mechanic was to attack and hold the area. Towny’s war event is the same thing, but there’s nothing physical. So I created a focus for the defenders. Attacking would have the attacker place a flag, which the defenders would need to break / take down. I eventually merged this into the Towny plugin. — @Zren – from his blog
It has since then been adapted over time to retain its core functionality, while it continues to provide server communities with a simple, yet fast and effective, way to capture territory.
About mid-2020, an effort to split it back off from Towny began. FlagWar was finally fully split off in 2021, marking its 10th anniversary.
FlagWar is licensed under the Apache License, Version 2.0, a license approved by the Open Source Initiative and is GPL Compatible. Some portions, such as shaded libraries, may be alternatively licensed. See the NOTICE for any alternative licensing or copyright limitations.
Documentation found on the FlagWar Wiki is licensed under CC BY 4.0.
Additionally, please respect Towny's license when using FlagWar with Towny. Use of FlagWar does not constitute a way to bypass Towny's license restrictions. When in doubt, ask for clarification.
| FlagWar Release | 📅 Released On | Requirements |
|---|---|---|
| v0.5.1 | October 27, 2021 | Towny (0.97.2.0+), Bukkit API-based* server (1.16.5, 1.17.1) |
| v0.4.0 | August 12, 2021 | Towny (0.97.0.17+), Bukkit API-based* server (1.16.5, 1.17.1) |
| Pre-History | 2011 - 2021 | Deprecated & Removed in Towny versions 0.97.0.0 and 0.97.1.0, respectively. |
FlagWar has adopted the use of Paper as an API provider. Spigot should however still be viable. Please submit a ticket if you experience any issues.
All Release builds and Development builds have been made available here on GitHub's Releases page.
We encourage server admins to "watch" FlagWar on GitHub in order to receive update notifications.
Just click the watch button in the upper right and select "Releases Only".
Sometimes, releases can be incubating for extended periods of time.
You can build from main if you want to test on the bleeding edge.
The documentation found on the FlagWar Wiki will be updated semi-regularly, usually after a tagged release. If you find the documentation insufficient, please open an issue so that we can address it.
On the Issue Tracker you can file bug reports, feature requests, or review / submit a QA discussion on the Towny discussion board.
If you still need help, come and join us on the TownyAdvanced Discord server. There, you can also find support, get notified on the latest updates for Towny, chat with other admins, and have discussions over plugin development with developers from multiple projects.
If you would like to contribute to the FlagWar code, first please read the Contributing Guidelines.
You will also want to ensure that your working environment is in order. You can check out Environment Setup over on our wiki to help you get started.
Documentation could also use a fair bit of work. Help in this department would be much appreciated.
We document both in plain-text (LICENSE, NOTICE) and in GitHub-Flavored Markdown (everywhere else).
If you are interested in writing for the FlagWar Wiki, feel free to ask on the Towny Discord (ping FlagCourier), or chime in on the Towny Discussion Board to be given write access.
The localization files for FlagWar are built directly into the jar using ResourceBundles.
To localize FlagWar to your language, copy the
Translation_en_US.properties file from the
resources directory as Translation_{LOCALE}.properties.
If a locale already exists, please refrain from creating a duplicate. Some locales may be stubs that were added for debugging purposes (en_GB, en_US[-_]POSIX, es_MX.) Feel free to modify them, but ensure they have the same key values as the master file (en_US).
The LOCALE, or the locale id compatible with the Java Locale class,
is a 1-to-3 segment string representing the language, the region, and the variant (if desired);
delimited primarily by underscores, with variants optionally being hyphenated.
Examples: en, en_US, en_US-POSIX.
See the Java Locale documentation for well-formed naming.
* FlagWar's Locale IDs should stick to the
lang(_REGION([_\-]VARIANT))format.
PRs to Locale processing are welcome. It's pretty messy in there...
After translation is complete, save your changes. You will need to Build FlagWar to ensure that all strings are accounted for, and that they render properly for end users.
Assuming you've got your environment properly set up, building FlagWar is relatively straight forward.
Steps:
- Clone FlagWar from GitHub.
- See the GitHub Docs, if you are unfamiliar with cloning projects.
- Navigate into the cloned
FlagWardirectory in your terminal. - Run
mvn clean packageto build FlagWar. This will generate files to theFlagWar/target/directory.- We also supply several maven profiles for convenience. Append
-P profileX,profileY,profileZto use them, obviously replacing the ridiculous placeholder profiles listed here. - The
checkstyleprofile will ensure that code edits are in-line with the code style guidelines. - The
javadocsprofile will generate aFlagWar-version-javadoc.jarfile, as well as theFlagWar/target/apidocs/folder.
- We also supply several maven profiles for convenience. Append
You can alternatively build FlagWar through your IDE, provided that it includes Maven, or that it can at least find it. Check your IDE's documentation regarding Maven support.
If you've found FlagWar to be of use and would like to support the project, then thank you!
You can support the project in multiple ways:
-
Contribute to the project 📝
Be it through adding or expanding a localization, endorsing the project, hunting for bugs, writing code, or writing documentation, any help is appreciated. -
Sponsor a Developer 💗
Sponsoring a developer gives back to those who have spent time to keep the project going.
See the sidebar for open sponsorships and learn about GitHub's Sponsors Program. -
Use FlagWar ⛳
Using FlagWar lets us know that people still love the war system.
Keeping metrics on, while optional, also gives us a rough idea of the adoption of FlagWar in the TownyAdvanced ecosystem.