BountyAPI
This mod makes adding custom bountys to the pitch-black stone hassle-free. It is targeted at mod development and doesn't do anything on its own.
About this mod Author’s original text
Bounty API
This mod serves as an API for other mods to use. It does nothing on its own. Use this mod to add custom challenges to the pitch-black stone in Hades 2. The functionality is documented using Lua annotations, so writing the following in your main.lua should give you autocomplete:
---@module "Siuhnexus-BountyAPI"
bountyAPI = mods["Siuhnexus-BountyAPI"]
Make sure to register your challenges only once when loading, so if you follow the structure of the mod template, just do something like this in your ready.lua:
bountyAPI.RegisterBounty({
Id = "ModAuthor-ModName_SuperDuperChallenge",
Title = "The Ultimate Challenge",
Description = "Face every guardian at once",
Difficulty = 5,
IsStandardBounty = false,
BiomeChar = "F",
DataOverrides = function (RegisterValues)
print("Overriding all the needed game tables for this challenge run...")
end,
SetupFunctions = function (BountyRunData, FromSave)
if FromSave then
print("Reacting to the data found in the persisted storage for this challenge run...")
else
print("Setting up the persisted data storage for this challenge run...")
end
end,
RoomTransition = function (BountyRunData, RoomName)
print("Room ".. RoomName.. " is being left. Choosing next room...")
end,
CanEnd = function (BountyRunData, RoomName)
print("Determining whether this challenge run should end")
return true
end,
EndFunctions = function (BountyRunData, Cleared)
print("Challenge run is ending. Cleaning up...")
end
})
If you have questions/ideas/weird bugs, feel free to open an issue or a pr.
Install & use Install: follow the bundled instructions
- Unzip the archive from playbuff and read the bundled readme / instructions first.
- Most mods rely on the game's mod loader — the usual route is a community mod manager (such as r2modman): pick this game, install, and it handles the loader and dependencies.
- For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
- Launch the game to confirm it loaded; mods with listed dependencies need those installed as well.
Install locations vary a lot between mods — the bundled readme is the most reliable guide. Hades II uses the game's built-in mod import — unzip the pack and place it where the readme says.
Install these first, or the mod will not work: