Phedg1Studios-StartingItemsGUI icon

StartingItemsGUI

This mod will allow players to use a GUI to select which items will be given to them at the start of a run. There are 3 modes: Free, Earnt Persistent and Earnt Consumable.

Last updated a month ago
Total downloads 13763
Total rating 9 
Dependency string Phedg1Studios-StartingItemsGUI-1.1.5
Dependants 1 other mod depends on this mod

This mod requires the following mods to function

wildbook-MiniRpcLib-0.0.1 icon
wildbook-MiniRpcLib

This is an alpha/beta library. It works, but there are breaking changes planned. It's released here to allow developers to reference it as a dependency.

Preferred version: 0.0.1
tristanmcpherson-R2API-2.4.21 icon
tristanmcpherson-R2API

A modding API for Risk of Rain 2

Preferred version: 2.4.21
bbepis-BepInExPack-3.2.0 icon
bbepis-BepInExPack

Unified BepInEx all-in-one modding pack - plugin framework, detour library

Preferred version: 3.2.0
README

Phedg1 Studios

Starting Items GUI

TLDR

This mod will allow players to use a GUI to select which items will be given to them at the start of a run. There are 3 modes: Free, Earnt Persistent and Earnt Consumable. Works in both singleplayer and multiplayer (if the host and the client have the mod installed, enabled and are using the same mode. NOTE: Each client has to select their own items).

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 boost to make them more formidable the more they play.

DESCRIPTION

The main menu will have a new button labelled "Starting Items". 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 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. Three buttons, labelled "Earnt Consumable", "Earnt Persistent" and "Free", are displayed on the bottom right of the interface. Clicking these will allow the player to change the mods mode. The differences of these three modes are detailed below. Another three buttons, labelled "Profile: 1", "Profile: 2" and "Profile: 3", are displayed in the bottom centre of the interface. Clicking these will allow the player to change the current item loadout. Buying an item in one profile does not affect the others, this is so a player could configure each profile differently to easily switch between them between games. Each of the 3 profiles is unique to each mod mode. This mod can be enabled and disabled from this menu, should the player wish to play normally again. When a game begins the items from the currently selected mod mode and profile will be spawned into the players inventory.

Mode: Earnt Consumable
Items in the shop interface will have a price associated with them. Buying an item will cost credits, selling an item will refund the full amount of credits. When a game is played while this mode is active the credits that were spent on items will be used up and consumed. The current profile will also have its items removed, they will have to be purchased again with the players remaining credits if they want to be spawned again in subsequent games.

Mode: Earnt Persistent
Items in the shop interface will have a price associated with them. Buying an item will cost credits, selling an item will refund the full amount of credits. When a game is played while this mode is active the credits that were spent on items will NOT be used up and consumed. The purchases will persist between games, as a kind of permanent upgrade to the players character.

Mode: Free
Items in the shop interface will have no price, they can be purchased as many times as the player wishes. The purchases will persist between games and will not be reset.

CREDIT EARNING METHODS

Credits will be earnt regardless of the current mode of the mod.

Boss Mode:
Players will earn credits for defeating endgame bosses. The amount of credits awarded per boss kill will vary based on the game's difficulty. Supported bosses in this mode are the: Lunar Scavanger. This feature will expand to include standard endgame boss introduced in the 1.0 update when it is released.

Stage Mode:
Players will earn credits for every stage they have cleared. The amount of credits awarded per stage cleared will vary based on the game's difficulty and how it ended (win, loss, obliteration). For the consumable mode players WILL NOT be accredited for any stages completed before adding this mod. For the persistent mode players WILL be accredited for all stages completed before adding this mod, though the amount of credits awarded per stage will be a flat rate unaffected by the difficulties and endings of those previous games. Due to feedback, a future version will remove this feature and these backdated credits will no longer be awarded.

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/Starting Items GUI/" and "<RISK OF RAIN 2 INSTALL LOCATION>/Risk of Rain 2/BepInEx/config/Phedg1 Studios/Starting Items GUI/<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.

Config.cfg
This file contains all of the settings which persist between profiles. It stores the whether the mod is currently enabled or disabled, the mode the mod is currently using and whether all items (including items which have not been unlocked) should be listed. Prices for all 8 tiers of items (common, uncommon, rare, boss, lunar, equipment, lunar equipment and elite equipment) are read from this file. The 7 credit reward multipliers for the Earnt Persistent mode (default, win, loss, obliteration, easy, normal and hard) are here also, as well as the 6 credit reward multipliers for the Earnt Consumable mode (win, loss, obliteration, easy, normal and hard).

Profiles.txt
This is the record of which profile the player was last using in each mode, so that it can persist after the game has been closed.

CreditsConsumable.txt
This file contains the number of credits (as an integer) that the player has earnt for the Earnt Consumable mode. Editing this file will update the credits in the mod.

CreditsPersistent.txt
This file contains the number of credits (as an integer) that the player has earnt for the Earnt Persistent mode. Editing this file will update the credits in the mod.

ItemsEarntConsumable.txt
This is the record of what items and equipment the player has purchased in the Earnt Consumable mode, so that they can persist after the game has been closed.

ItemsEarntPersistent.txt
This is the record of what items and equipment the player has purchased in the Earnt Persistent mode, so that they can persist after the game has been closed.

ItemsFree.txt
This is the record of what items and equipment the player has purchased in the Free mode, so that they can persist after the game has been closed.

Changelog

v1.1.5
Added new credit earning method.
Internal broken items should not be listed in the Item Drop List menu any longer.
Changed how equipment id's are stored to try and mirror the source code in an effort to somewhat future proof.
Changed how persistent credits were stored to match consumable credits.
Prevented this gui from making other menus uninteractable any more (again).

v1.1.4
Increased required version of R2API so that custom items are now supported.
Replaced some hooks with events. This fixes starting items not being given to multiplayer clients in some situations, as previously other mods were crashing this mods initialization thread on clients.
Added version parameter to the config so changes to config files can be applied to existing config files.
Added options to config to disable and hide any of the purchasing modes.
Moved config for giving a fixed total of credits in the EarntPersistent mode into the main config file.
Modified config descriptions so they show up cleaner in the mod manager.
Prevented this gui from making other menus uninteractable any more.

v1.1.3
Changed configuration files and extensions to better support r2modman.

v1.1.2
Fixed GUI scaling for different resolutions and aspect ratios

v1.1.1
Added a new config file to adjust / augment the amount of credits a player has in the Earnt Persistent mode.

v1.1.0
Now compatible with the Artifacts update.
Updated the visual style to match the new UI.
Increased the scrolling speed of the starting items menu.
Added support for additional difficulties added by other mods, so credits are now earned while playing them.
Fixed a bug where items could not be removed when in the Free mode.
Fixed a bug where unfinished items would show when show all items was enabled.
Decoupled the mod from the base game to a much greater extent.

v1.0.0
Initial release.

Available versions

Please note that the install buttons only work if you have compatible client software installed. Otherwise use the zip download links instead.

Upload date Version number Downloads Download link  
2020-5-26 1.1.5 2366 Phedg1Studios-StartingItemsGUI-1.1.5.zip Install
2020-4-29 1.1.4 2668 Phedg1Studios-StartingItemsGUI-1.1.4.zip Install
2020-4-19 1.1.3 1476 Phedg1Studios-StartingItemsGUI-1.1.3.zip Install
2020-4-7 1.1.2 3085 Phedg1Studios-StartingItemsGUI-1.1.2.zip Install
2020-4-4 1.1.1 1193 Phedg1Studios-StartingItemsGUI-1.1.1.zip Install
2020-4-4 1.1.0 296 Phedg1Studios-StartingItemsGUI-1.1.0.zip Install
2020-3-15 1.0.0 2679 Phedg1Studios-StartingItemsGUI-1.0.0.zip Install