README

forumify MILHQ

Personnel & unit management for MilSim units

MILHQ is forumify's first-party unit and personnel management plugin, built for military simulation units and other structured communities. It brings personnel tracking, chain of command and operational logistics straight into your forumify community.

📖 Documentation: docs.forumify.net/plugins/milhq-plugin

Features

Organization Setup: units, positions, specialties, statuses and rosters to model your chain of command.
Enlistment: let forum members apply to join your unit.
Forms: custom forms with submissions and supervisor review.
Assignments: track where every soldier serves, and every move they make.
Ranks: rank groups, promotions and demotions.
Awards: medals and ribbons, with tiers and groups.
Qualifications: certify soldiers for roles and equipment.
Combat Records: a complete service history for every soldier.
Courses: schedule classes, assign instructors and report results.
Operations: plan operations and missions, collect RSVPs and write after action reports.
Attendance Tracking: see who shows up, and who doesn't.
Report In: keep your roster active with periodic check-ins.

Integrations

MILHQ works on its own, but integrates with other forumify plugins when they are installed:

forumify-calendar-plugin: missions and course classes show up on your calendars.
forumify-discord-plugin: look up soldiers, units, ranks, awards and qualifications with Discord commands.

Installation

MILHQ can be installed from the forumify marketplace, or manually with composer:

composer require forumify/forumify-milhq-plugin

Afterwards, activate the plugin from the plugins page in your forumify admin panel.

See the documentation to get your unit set up.

Contributing

When you believe you've found a bug or think the plugin could be expanded with a new feature, you can start by creating an issue here on GitHub.

The easiest way to work on MILHQ is by using the production template and installing the plugin with composer using a symlink.

Add the following to the template's composer.json:

    "repositories": [
        {
            "type": "path",
            "url": "../forumify-milhq-plugin"
        }
    ]

Now when you run composer require forumify/forumify-milhq-plugin, the plugin will be symlinked and any changes you make will immediately be available in your project.

Code quality

The following checks are performed when you create a pull request:

Tests: PHPUnit, run with and without the optional calendar and discord plugins
CodeStyle: checked by PHPCS, using the PSR-2 codestyle extended with Slevomat rules
Static analysis: checked by PHPStan
JavaScript: checked by ESLint

You can avoid failing builds by running these tools locally:

On Linux/WSL/MacOS:

Quality checks: make quality
Tests: make tests

The tests require a MySQL 8.4 database, configured through DATABASE_URL in .env.

On Windows:

See commands in Makefile and execute manually.

License

MILHQ is released under the Open Software License 3.0.

forumify / forumify-milhq-plugin

Package info

Security

Statistics