Release Notes Template - MegaMek/megamek GitHub Wiki

Introduction and Pre-Amble

Release Highlights for MegaMek

New Features

  • [List of new features specific to MegaMek]

Improvements

  • [List of improvements specific to MegaMek]

Release Highlights for MegaMekLab

New Features

  • [List of new features specific to MegaMekLab]

Improvements

  • [List of improvements specific to MegaMekLab]

Release Highlights for MekHQ

New Features

  • [List of new features specific to MekHQ]

Improvements

  • [List of improvements specific to MekHQ]

Java 17 is Required for all 0.50.x Releases

Starting with version 0.50.0-Development, Java 17 will be REQUIRED to play. We’ve updated our guide to Updating to Adoptium (Eclipse Temurin Open Source Java) with more detailed instructions.

It’s crucial to read the directions carefully, especially Step 6, which covers a recent change to the Adoptium installer. Make sure to select “Install for all users of this machine” in the Installation Scope.

We will continue using Java 17 until Fall 2026. If you choose to use a Java version beyond 17, it isn’t officially supported, and our standard response for issues will be to revert to Java 17. We recommend upgrading to Java 17 before the new release; if you are running 0.49.12-Development or later, it will run on Java 17.

A Few Reminders

The Milestone System Summary

Please see this link for details on the replacement for the old Stable and Development cycle.

Pre-Release Notes for 0.50.0-Development Cycle (August 25, 2024)

This post covers some of the key changes that are happening as we go into the 0.50.xx-Development cycle. Read more here.

State of the Universe (January 19, 2024)

If you haven't given the State of the Universe (read here if you missed it) a read, please do. There's lots of information in there that is still recent and relevant.

User Data Directory for MegaMek, MegaMekLab, and MekHQ

We've added a customizable User Data Directory feature. This allows you to set a single external directory for storing game resources like units, camos, and fonts, which is accessible across different installations and versions of MegaMek, MegaMekLab, and MekHQ.

Key Points:

  • Set a Custom Directory: Choose any location on your computer (e.g., D:/myMMStuff) to keep your game resources.
  • File Placement:
    • Fonts and units (.mtf, .blk) can be placed anywhere within this directory.
    • Camo images in /data/images/camo/
    • Portrait images in /data/images/portraits/
    • Unit fluff images in /data/images/fluff/<unit type>/
    • Rank and award definition files (.xml) in /data/universe/
  • Consistent Access: Resources in this directory are usable across different game versions and modules without needing to relocate them for each new install.
  • Implementation: Set up this directory via the client settings. A game restart is required for changes to take effect.

Important: MekHQ Campaign Update Instructions

It is critical to follow these steps to ensure the integrity of your MekHQ campaign when updating between versions. Failure to follow these steps can result in the corruption of your campaign file.

Treat each release as stand-alone; Copy, never Move your data forward from older versions. MekHQ is NOT backward compatible.

  1. Complete all ongoing contracts in your current campaign, save, and exit the program.
  2. Make a backup of your campaign and custom files. This is a critical step to prevent data loss!
  3. DO NOT COPY MegaMek saves or any preference file from a different version to avoid compatibility issues.
  4. Update MekHQ to the latest version. NEVER overwrite the existing folder; always keep each version in its own folder.
  5. In the new version, load your save file in MekHQ and advance the game by one day.
  6. Re-save any custom presets to ensure they are updated with the new version's settings.
  7. Exit MekHQ and restart the application to complete the update process.

Following these steps will ensure that your campaign data initializes correctly and avoids potential issues. This process is essential for maintaining campaign stability.

Social Media

Join our official MegaMek Discord, our primary community hub for the suite. We offer superior voice support, individual channels, and assistance for the official public servers. We're also part of community Discords Everything BattleTech and Classic BattleTech. Find us on Facebook at MegaMek BattleTech and MegaMek.

Contributing

Interested in contributing? Find out how here.

Change Logs (Release Specific) and Download Links

MegaMek Change Log

[Download](LINK TO RELEASE)

MegaMekLab Change Log

[Download](LINK TO RELEASE)

MekHQ Change Log

[Download](LINK TO RELEASE)

⚠️ **GitHub.com Fallback** ⚠️