Phedg1 Studios

Earn Starting Items

TLDR

This mod will allow players to earn credits which they can use to purchase starting items in an item shop. Works in both singleplayer and multiplayer (if the host and the client have the mod installed and enabled).

INSPIRATION

This mod was inspired by features in other roguelike games such as Undermine, Dungreed and Dead Cells. The goal was to give a returning player a sense of progression, to give them a permanent boost to make them more formidable the more they play. This boost will have to be earnt, rather than using a player’s discretion, so they do not feel like they are cheating.

DESCRIPTION

Players will credits for every stage they have cleared. The amount of credits awarded per stage cleared after the mod has been installed will vary based on the game's difficulty and how it ended (win, loss, obliteration). Players will also be accredited for all stages completed before adding this mod, though the amount of credits awarded per stae will be a flat rate uneffected by the diffulties and endings of those previous games. Additionally, The main menu will have a new button labelled "Item Shop". Clicking it will open up the shop interface. Every item and piece of equipment that has been unlocked (completed the requisite achievement) and discovered (been picked up at least once) will be listed here, alongside its price and how many times it has been purchased. To purchase an item or piece of equipment, left click it. The same item can be purchased multiple times. To sell an item or piece of equipment, right click it. Selling an item or piece of equipment gives a full refund. Every item and piece of equipment that has been purchased will be spawned at the beginning of every game. The credits, items and pieces of equipment are not "used up" by playing a game, they will persist and be spawned for every future game. This mod can be enabled and disabled from this menu, should the player wish to play normally again.

CONFIGURATION

After a player has opened the item shop interface for the first time a number of configuration files will be created. These can be found at "<RISK OF RAIN 2 INSTALL LOCATION>/Risk of Rain 2/BepInEx/config/Phedg1 Studios/Earn Starting Items/" and "<RISK OF RAIN 2 INSTALL LOCATION>/Risk of Rain 2/BepInEx/config/Phedg1 Studios/Earn Starting Items/<YOUR PROFILE ID>/". If you desire to alter the configuration of the mod it must be done by editing these files. The intention is that this would only be necessary once, with the rest of the player's interactions being done through the shop interface inside the game itself.

ShowAllItems.cfg When this file is blank the player will only have access to the items and equipment that they have unlocked and discovered. If anything is written inside this file, they will have access to every item and piece of equipment in the game.

ItemPrices.cfg Contains the number of credits (in integers) that the different types of items cost, separated by a comma. These types are, from left to right; tier 1 items (white), tier 2 items (green), tier 3 items (red), boss items (yellow), lunar items (blue), equipment (orange), lunar equipment (blue), elite / hidden equipment (orange). Editing these values will update them in the store.

ProfileCredits.cfg When this file is blank the player will only be accredited for the credits they have earnt. Enter the number of credits (as an integer) to override the number of credits this player has to spend in the shop.

UserStages.cfg Contains the number of stages (in integers) that the player has completed since the mod was installed, broken into the 9 possible game types. These types from left to right are: easy win, easy loss, easy obliteration, medium win, medium loss, medium obliteration, hard win, hard loss, hard obliteration. Editing these values will update the number of points a user has.

RewardMultipliers.cfg Contains the multipliers for how many credits are earned for each stage cleared based on the games results. From left to right these are: default, win, loss, obliteration, easy, medium, hard. The amount of credits earned for an medium obliteration game would be gameStages * medium * obliteration. The default multiplier is used for all stages completed before this mod weas installed, the amount of credits earned would be previousStages * default.

ItemsPurchased.cfg This is the record of what items and equipment the player has purchased, so that they can persist after the game has been closed.

Enabled.cfg This is the record of whether the mod is enabled, so that it can persist after the game has been closed.

Changelog

v1.0.4 Hopefully fixed a scaling issue when playing at different resolutions. Enabled button will now show the correct label when there are no items that have been unlocked and discovered. Changed the extension on the configuration files from .txt to .cfg for compatability with r2modman mod manager.

v1.0.3 The amount of credits earned now scales based on the difficulty of the game and how it was ended.

v1.0.2 Added multiplayer support. Items now appear directly in player's inventories instead of spawning on the ground. Changed which event causes items to spawn so items now spawn for acrid. Changed the location of some config files so they are now global.

v1.0.1 Added enabled toggle to game menu.

v1.0.0 Initial release.