Stats Core

What is Stats Core?

Stats Core is an API whose specific goal is to allow easy modification of Player stats and Equipment stats. It's designed with stability, ease of use, and mod compatibility in mind. Using Stats Core means your mods will be using well tested, mod friendly, bug free code.

Benefit of using Stats Core:

Some mods, like changing Max Hunger, are very complicated to do as they are hard coded and spread out over around 7 different methods. Without Stats Core you'd spend several hours or even days trying figuring everything out, creating all of patches, and testing the code for bugs. With Stats Core, this single line of code is all it takes:

Player.main. AddMaxFood(amount);

That one line is all it takes and Stats Core will do the rest. It will patch all 7 or so methods using heavily tested code. Using Stats Core lets you focus on what's important, developing your mod. No longer will you need to spend hours trying to do all the setup just to start  working on a feature for your mod.

What can Stats Core currently do?

Stats Core lets you modify most of the player stats. Some examples are max health, max food, max water, lung capacity, etc. It also adds custom-made stats like Health Regen, Dehydration damage (now separate from Starve damage), damage resistances, and more. There's also a growing number of custom methods like IsSwimmingOnWaterSurface(), to provide your mods with greater accuracy. Additionally, any stats that would normally affect GUI, like health, water, and food have also been patched. So changing max health will change the health bar to reflect your new max health.

It also makes many  of the normally private "stat-related" properties public. This is helpful because now you can make stat mods that don't require the use of reflection or publicized assemblies.

You can also use Stats Core to modify equipment stats. Currently support has been added for the Knife, Heat Blade, Flash Light, Laser Cutter, Flare, and Fire Extinguisher.

Future Plans:

There are many planned features for Stats Core. Eventually it will include modifiers for every piece of equipment, vehicle, creature, important items, and more. I am trying to design this so all future modders would want to use this over doing it by hand, so expect a lot of support and new features in the future.

Want more info?

Check out the API yourself. Try making a demo mod and seeing what kinds of changes you can make. You can also:

• Contact me in the Subnautica Modding Discord. My username is gurrenm4#2395 .

• Check out the source Code and get more info here: https://github.com/gurrenm3/Stats-Core