EasyChallenges

v1.0.7·Updated 2023-02-17

Custom Challenges Made Easy

About this mod Author’s original text

EasyChallenges

Custom Challenges Made Easy

This mod allows you to easily add custom challenges into the game by specifying them in JSON files.

To add your own challenges, create a new folder inside BepInEx\plugins and create a new.challenges.json file (like chendraks.challenges.json) inside that folder.

An example structure could look like this:

BepInEx

  • plugins
  • ChendraksChallenges
  • chendraks.challenges.json

EasyChallenges will scan for *.challenges.json files in BepInEx\plugins subfolders.

The full file format is specified below.

Troubleshooting

If your challenges don't show up, please check BepInEx\LogOutput.log and BepInEx\ErrorLog.log for potential ideas as to why.

If there is no information in the logs, feel free to swing by the Rogue: Genesia Discord and ask there.

Changelog

1.0.7

  • Fix for game changes on how localization is handled
  • Add ability to create Survivor Mode challenges
  • The Mod will now log the valid game modes and difficulties on startup

1.0.6

  • Fix for most recent game version

1.0.5

  • Fix challenge completion resetting

1.0.4

  • Fix more documentation issues
  • Add the ability to banish cards by stat using BanishedCardStats

1.0.3

  • Fix some documentation issues

1.0.2

  • Updated for the current beta
  • The mod now has version checks, so it will only load on supported game versions

1.0.1

  • Added StagesHidden, StartingCards and BanishedCards to ChallengeModifier
  • StartingCards and BanishedCards have their own descriptions

1.0.0

  • Initial Release

File Format

{

// ModSource will be displayed at the end of the challenge descriptions

"ModSource": "Your Mod Name Here",

"Challenges": [

{

// Internal name of your new challenge. This needs to be unique.

// Consider using a prefix for all your challenges.

// Required

"Name": "CC_Challenge1",

// The difficulty this challenge will be shown under.

// Required, will default to RogF if not provided

"Difficulty": "RogF",

// The difficulty this challenge will be shown under.

// Required, will default to "RogMode" if not provided

"GameMode": "RogMode",

// The maximum allowed soul shop tier for your run.

// Optional, Default is MAX

"MaxAllowedSoulShopTier": "F",

// Where should your challenge show in the list? Higher numbers will

// result in your challenge being shown further down the list

// Optional, defaults to 9

"Order": 1,

// Is this a hard mode challenge?

// Optional, defaults to false

"IsHardMode": true,

// All soul coins you gain will be multiplied by this value

// Optional, defaults to 1

"SoulCoinModifier": 1.5,

// Translations for your challenges name

// Required

"NameLocalization": {

"en": "My First Challenge"

},

// Custom descriptions for your challenge

// Optional

"Descriptions": [

{

"Type": "Positive",

"Localizations": {

"en": "A description for a positive modifier",

"fr": "A french description"

}

},

{

"Type": "Neutral",

"Localizations": {

"en": "The Precursor for snuffheads favorite"

}

},

{

"Type": "Negative",

"Localizations": {

"en": "A description for a negative modifier"

}

}

],

// Defines the modifiers for your challenge

// Required

"ChallengeModifier": {

// The player is given these cards at the start of the run

// Note: These are only applied once you enter the first stage!

// Optional

"StartingCards": [ "EvilRing" ],

// These cards will be banished at the start of the run

// Note: These are only applied once you enter the first stage!

// Optional

"BanishedCards": [ "Cardio" ],

// Cards with these stats will be banished at the start of the run

// Note: These are only applied once you enter the first stage!

// Optional

"BanishedCardStats": [ "CriticalChance", "CriticalMultiplier" ],

// Which artifacts should not be available in your challenge?

// Optional

"BanishedArtifacts": [ "PhoenixTotem" ],

// Which artifacts should be in your inventory at the start at your challenge?

// Optional

"StartingArtifacts": [ "TrainingWeight", "SageLeaf" ],

// What should the

Install & use Install: follow the bundled instructions

  1. Unzip the archive from playbuff and read the bundled readme / instructions first.
  2. 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.
  3. For a manual install, put the mod files into the matching Mod / plugins folder inside the game directory.
  4. 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.

Dependencies

Install these first, or the mod will not work:

BepInEx-BepInExPack_RogueGenesia

File & checksum

Filename
EasyChallenges-1.0.7.zip
File size
36.0 KiB