Require first-time Axolotl-PM players to accept server rules through a form
- The plugin declares Axolotl-PM API 5.0.0 in
plugin.yml. - The build includes pmforms as a private virion. Install the release PHAR as one file. The server does not need a separate pmforms plugin.
- The source has passed PHPStan at maximum level against Axolotl-PM 5.51.1. The release workflow records the exact source revisions used for each build. Compatibility with every API 5 server patch has not been verified.
- Download the PHAR from GitHub Releases and place it in the server's
plugins/directory. - Start the server once to create
plugins/AdvancedRules/config.yml. - Edit
Rules, the form title, and the messages in that file. Restart the server to apply changes.
A player with no acceptance marker sees the rules form after joining. Accepting creates plugins/AdvancedRules/data/<player name>. With KickMode: true, declining or closing the form disconnects the player. With KickMode: false, the form is shown again until the player accepts. Keep the data/ directory when updating if you want to preserve existing agreements. Back it up before changing player identity or storage policy.
The /advancedrules command, also available as /rules, shows the rules without asking for another acceptance. Its permission is advancedrules.command and is granted to players by default.
The included default configuration documents the supported keys. Rules supports § color codes and \n line breaks. KickMode controls what happens when a player declines or closes the form. The legacy key AgreeButon is intentionally retained so existing configurations continue to work.
The build workflow uses DevTools to analyze the plugin, generate a standalone PHAR, and validate its checksum. The pmforms Git submodule pins the bundled library to a reviewed commit. Clone with submodules when building locally. Dependabot checks GitHub Actions and the submodule for updates. Proposed updates require CI and runtime review before they are merged.
AdvancedRules is distributed under GPL-3.0. The bundled pmforms library retains its LGPL-3.0 license in the PHAR. For support, open a GitHub issue or visit NhanAZ Discord.