Hades2GameDef

For mod developers only! Community sourced definition files using luaCATS annotations, for Hades 2 in the context of ReturnOfModding.

Contributing

Contribute to this project by adding informative descriptions or annotations to the base.lua (fields defined from the engine as part of base lua), engine.lua (other fields defined from the engine), load.lua (fields available only after a save loads), and any lua files in the Scripts folder.

Check out the dev branch and Make a PR to it with your changes, and review other PRs. Eventually by enough merges they will be rolled into a release in the main branch.

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

2.1.0 - 2026-09-14

Added

• Added ---@field [any] any to game.GameState, removing subfield reference warnings

Changed

• Updated for Post-Launch Patch 2 - Hotfix 5
• Removed baked-in live values, such as screen resolution dependent values

2.0.0 - 2024-05-21

Added

• 'game-import' when using something that imports all of the globals into your environment

Changed

• Reserve the name 'game' for definitions
• Rename prefixes, e.g. 'SGG_Modding-Hades2GameDef' became 'game'

1.0.1 - 2024-05-15

Added

• Initial Thunderstore release.