search

MegaMek / mekhq

MekHQ is a java helper program for the MegaMek game that allows users to load a list of entities from an XML file, perform repairs and customizations, and then save the new entities to another XML file that can be loaded into MegaMek.
http://megamek.org
134 stars 172 forks source link

readme

MekHQ

Table of Contents

  1. About
  2. Status
  3. Compiling
  4. Support
  5. License

1. About

MekHQ is a Java helper program for the MegaMek game that allows users to load a list of entities from an XML file, perform repairs and customizations, and then save the new entities to another XML file that can be loaded into MegaMek. For more details, see our website and join our Discord.

2. Status

Type MM Status MML Status MHQ Status
Latest Release Release Release Release
Javadocs javadoc javadoc javadoc
License GPLv3 license GPLv3 license GPLv3 license
Build (CI) MM Nightly CI MML Nightly CI MHQ Nightly CI
Issues GitHub Issues GitHub Issues GitHub Issues
PRs GitHub Open Pull Requests GitHub Open Pull Requests GitHub Open Pull Requests
Code Coverage MegaMek codecov.io MegaMekLab codecov.io MekHQ codecov.io

Note that not everything has been implemented across the suite at this time, which will lead to gaps.

3. Compiling

1) Install Gradle.

2) Follow the instructions on the wiki for using Gradle.

3.1 Style Guide

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.

To help with additional checks, you can run the following commands within a terminal to see what is in compliance. There will be a lot of output while we clean up our code, so please only focus on the files with which you are editing.

./gradlew editorconfigCheck
./gradlew check

The first ensures compliance with with the EditorConfig file, the other works with the Google Style Guide for most of the rest.

4. Support

For bugs, crashes, or other issues you can fill out a GitHub issue request.

5. License

MekHQ is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
MekHQ is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with MekHQ. If not, see <http://www.gnu.org/licenses/>.

Please see MekHQ/license.txt for more information.