Home

Welcome and General Information

• Mission Statement
• MegaMek and BattleTech
• Contact us ‐ Social Media and Website locations
• Team members
• Milestone Releases
• Unofficial or Non‐Canon Content Policy
• I want to help

For Players

Getting Started

• Java and MegaMek
• Updating to Adoptium (Eclipse Temurin Open Source Java)
• tar.gz and the MegaMek Suite
• Setting Up a Custom User Data Directory for MegaMek, MegaMekLab, and MekHQ
• Links to Video Tutorials

MegaMek

• What Can Princess (the Bot) Currently Do?
• MegaMek, 2d6, and the Art of Rolling the Dice Without Losing Your Mechs—or Your Mind
• How to join and host a game of MegaMek
• How do I print a MegaMek Map for Tabletop

MegaMek In-game Mechanics

• Plant Demolition Charges with Infantry
• Laying Mines with the Fa Shih
• Loading Infantry and Battle Armor
• Using TAG with Artillery
• Strafing

MegaMekLab

• What Units does MegaMekLab build and Print
• Exporting PDFs in MegaMekLab
• How do I get Record Sheets I can use with table top game?

MekHQ

• Running a Co-op campaign with MekHQ
• Moving MekHQ Campaign Files between versions
• StratCon Reference and FAQ

Common Features

• Large Craft in MegaMek, MegaMekLab, and MekHQ
• How do I get Fluff Images to work

Maps and Tilesets

• MegaMek Tilesets and Tileincs
• Drawing Boards: Advanced Topics

Custom Units

• How do I add custom units?
• How do I add Sprites to Custom Units
• How do I add Quirks to Customs Units
• How to draw MegaMek Sprites the Deadborder way

Troubleshooting and Known Issues

General Issues

• Weird artifacts Screen Distortions
• Increasing Memory (Can help with the bot)
• Memory and our software
• Name Issues with Units
• Clearing the Font Cache
• Issues upgrading from Java 8 (Upgrade loop)

Linux-Specific Issues

• MekHQ select Campaign Preset box behind splash (Linux specific)

macOS-Specific Issues

• OSX Issues

Windows-Specific Issues

(Currently empty, but included for future additions)

For Developers

• Developer Expectations
• MegaMek Coding Style Guide
• Working With Gradle
• Adding Language Support to MegaMek
• Development Mailing List
• Nightly Builds

Setting up Development Environments

• Complete Development Environment Setup using IntelliJ Idea
• Setting Up Multiple Interdependent Projects in IntelliJ IDEA
• Importing Projects to Eclipse

Contribution Guidelines

• Commit Procedures
• Creating a Pull Request (PR) as an Outside Contributor

Testing

• About Unit Tests
• Running Unit Tests
• Writing Unit Tests

Release Process

• Release Procedure ‐ Running the Packaging Scripts
• Release Notes Template

Deprecated Content

• Updating to Adoptium
• Stable vs. Development (Deprecated)
• Slow Unzipping or Errors Unzipping (Depreciated after version 0.50.0)
• HowTo: Eclipse EGit and the Projects
• How do I add Sprites to Custom Units (Depreciated after 0.49.19)
• How do I add Quirks to Customs Units (Depreciated)
• (Any other deprecated entries)