MekHQ is a Java helper program for the MegaMek game that allows users to run a campaign. For more details, see our website and join our Discord.
| Type | MM Status | MML Status | MHQ Status |
|---|---|---|---|
| Latest Release |  |
 |
 |
| Javadocs | |||
| License |  |
|
|
| Build (CI) | |||
| Issues | |||
| PRs | |||
| Code Coverage |  |
 |
 |
Note that not everything has been implemented across the suite at this time, which will lead to gaps.
-
Install Gradle.
-
Follow the instructions on the wiki for using Gradle.
When contributing to this project, please enable the EditorConfig option within your IDE to ensure some basic compliance with our style guide which includes some defaults for line length, tabs vs spaces, etc. When all else fails, we follow the Google Java Style Guide.
The first ensures compliance with with the EditorConfig file, the other works with the Google Style Guide for most of the rest.
For bugs, crashes, or other issues you can fill out a GitHub issue request.
MekHQ is licensed under a dual-licensing approach:
All source code is licensed under the GNU General Public License v3.0 (GPLv3). See the LICENSE.code file for details.
Game data, artwork, and other non-code assets are licensed under the Creative Commons Attribution-NonCommercial 4.0 International License (CC-BY-NC-4.0). See the LICENSE.assets file for details.
MechWarrior, BattleMech, `Mech, and AeroTech are registered trademarks of The Topps Company, Inc. All Rights Reserved. Catalyst Game Labs and the Catalyst Game Labs logo are trademarks of InMediaRes Productions, LLC.
The BattleTech name for electronic games is a trademark of Microsoft Corporation.
MegaMek is an unofficial, fan-created digital adaptation and is not affiliated with, endorsed by, or licensed by Microsoft Corporation, The Topps Company, Inc., or Catalyst Game Labs.
For complete information about licensing, including specific directories and files, please see the LICENSE document.