https://github.com/elitemastereric/challengeapi
A library for BoI: Repentence to ease the creation of custom challenges.
https://github.com/elitemastereric/challengeapi
binding-of-isaac modding video-games
Last synced: 12 months ago
JSON representation
A library for BoI: Repentence to ease the creation of custom challenges.
- Host: GitHub
- URL: https://github.com/elitemastereric/challengeapi
- Owner: EliteMasterEric
- License: mit
- Created: 2025-04-27T23:06:35.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2025-06-01T05:35:51.000Z (about 1 year ago)
- Last Synced: 2025-06-11T00:42:53.363Z (12 months ago)
- Topics: binding-of-isaac, modding, video-games
- Language: Lua
- Homepage: https://steamcommunity.com/sharedfiles/filedetails/?id=3478225226
- Size: 13 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# ChallengeAPI
A library mod for providing custom challenge-related functionality, including custom goals, EID descriptions, and more.
## Functionality
- Adds a new category to External Item Descriptions. Hold the MAP button to view the goal, starting items, and restrictions for the current challenge.
- Vanilla challenges are automatically registered.
- (REPENTOGON only) Descriptions are automatically generated for custom challenges, and can be edited with a straightforward API.
- Replaces the challenge goal HUD icon with a customizable interface.
- This allows you to create custom challenge goals and display them in the challenge HUD and in the EID description.
- Built-in fixes for challenge goals which would otherwise have major issues:
- The Beast (trophy spawning and softlock prevention)
- Built-in fixes for challenge XML attributes which would otherwise have major issues:
- `startingpill` (properly supports Little Baggy)
## Upcoming Features
- Built-in fixes for the following challenge goals:
- [] Delirium
- [] Hush
- [] Boss Rush
- [] Mausoleum II
- Functionality to force stage types for specific floors
- 30 floors of Cellar, anyone?
- (REPENTOGON only) Custom challenge XML attributes
[] startingpocketitems="collectibleId,commaSeparated"
[] notrinkets=true/false
[] startinggulpedtrinkets="trinketId,commaSeparated"
- Known issues:
[] Challenge goal HUD displays even during cutscenes.
goto x.itemdungeon.666
## Documentation
See [the API documentation](docs/api.md) for more information on how to use this library to add custom challenge goals and descriptions to your mods.
## Credits
- **EliteMasterEric**: Lead Developer
- **CevaSkullderg**: Playtesting
**Special Thanks**
- **Lizzy**: For being awesome
- **wofsauge**: For structuring External Item Descriptions well