Skip to content

Latest commit

 

History

History
61 lines (42 loc) · 4.7 KB

README.md

File metadata and controls

61 lines (42 loc) · 4.7 KB
Raw

Moonstorm Shared Utils - Content Loading and General Utility Framework for Large Content Mods.

MoonstormSharedUtils, otherwise known as MSU, is an API designed to work around the ThunderKit system for creating Content Mods.

Originally part of the API and Framework built for updating Starstorm2 to a ThunderKit setup for a better development experience, it has grown exponentially into it's own separate library so anyone with the desire to create large Content mods with thunderkit can use it.

Goals of the API

MSU strifes for the following goals regarding mod development and management.

  • Simple but powerful systems for managing and loading content for the game in an Asynchronous fashion.
  • A robust framework built upon modules that allows you to automate various parts of the modding workflow, such as equipment execution, monster and interactable spawning, and more.
  • Simplification of the ThunderKit workflow by providing a custom set of CompossableObjects for managing Manifests, Paths and Pipelines.
  • A High enphasis on utilizing the systems provided by the game over hooks whenever possible, such as default provided delegates, base item behaviours, and more.
  • Utilization of the Existing R2API Framework to power systems such as Director modifications.
  • Emphasis on working within the Editor instead of working on code for the creation of assets.

The purpose of this Github.

The Github is used as the main front of the API, Used for creating new issues and as well for development of the project itself.

To get started developing new features for MSU, please look at the ONBOARDING document.

Donations

MSU is a passion project from one of TeamMoonstorm's members, Nebby. as such, he works in his free time on this to allow the rest of the community to create amazing and awe-inspiring content.

MSU will forever be free to use and never gated behind paywalls, however, donations are incredibly appreciated.

ko-fi

Mods Utilizing MSU

(Click me!)

(Note: click the icon to open a new tab to the Mod!)

Icon/URL Name Description
StarstormIcon Starstorm2 A sequel to Starstorm 1. Adds new survivors, mechanics, items, skills, enemies, and more!
LostInTransitIcon Lost in Transit Lost in Transit is a mod focused on restoring features lost from Risk of Rain 1, currently including items.
VarianceAPIIcon Variance API VarianceAPI allows you to create Variants for CharacterBodies, Variants can have different textures, lights, skills, and more.
FortunesFromTheScrapyardIcon TO BE RELEASED - Fortunes from the Scrapyard An expansion-esque content mod that revolves around a third party Space Corporation, and visually based on Junkyard and Cyberpunk themes.
RulersOfTheRedPlaneIcon Rulers of the Red Plane A general content mod expanding upon the Red Plane

Thanks and Credits

  • Twiner for the creation of ThunderKit.
  • IDeath and Harb for helping out with various coding questions.
  • KingEnderBrine and RuneFox237 for the RoR2SkinBuilder, which was used as a base for the VanillaSkinDef system.
  • GrooveSalad for helping out during the conceptualization of the module system and providing the StubbedShaders.
  • UnknownGlaze for MSU's Logo
  • The Starstorm 2 Team, for allowing nebby to go off the deep end and create MSU in the first place.
  • The Fortunes from the Scrapyard team, for believing in my goals and utilizing MSU for their mod.
  • KevinFromHPCustomerService, for creating the original modules systems that eventually became MSU 2.0
  • Everyone from the Risk of Rain 2 community for appreciating my work.