RUMBLE RumbleStats1.0.1

You are viewing a potentially older version of this package. View Latest Version

Install

Date Uploaded

last year

Downloads

1.3K

Size

92KB

Dependency string

ERRORMODS-RumbleStats-1.0.1

Download

Details Required (2)Versions

Installation Instructions

Install MelonLoader
Run Game and close it when you get to T-Pose
Drop "Mods" Folder in to Rumble Source Directory
Run the Game.

How to Use

If you have other mods installed that use this mod, they will store their statistics in their respective folders inside your UserData folder in the root game directory.
If you don't have any mods installed that use this mod, it will store some base statistics that come with the mod.

Have fun!

Documentation

`StatsMod` Class

Properties

ModName: Name of the mod for indentifying and organizing data files.
storeEntryTime: Boolean value to include timestamps for each entry.
DebugMode: Boolean value to enable debug mode (logging to console).

Methods

InitializeStatFile
- Creates a new CSV file with specified columns.
- Parameters:
  - fileName: Name of the CSV file.
  - columns: Dictionary (string, type) of column names and their data types.
- Example:
```
var columns = new Dictionary<string, Type>
{
    { "Player Name", typeof(string) },
    { "Battle Points", typeof(int) }
};
mod.InitializeStatFile("PlayerStats", columns);
```
StatFileExists
- Checks if a specific stat file exists.
- Returns: true if the file exists, otherwise false.
GetAllRows
- Reads all rows from a CSV file.
- Parameters:
  - csvFileName: The name of the file to read.
  - skipHeader: Boolean value to skip the header row.
- Returns: A list of string arrays representing rows.
AddStatRow
- Adds a new row to the CSV file.
- Parameters:
  - values: Array of object values for the row. Make sure they match the column types defined in the CSV file, in the same order, and the same amount of values.
  - csvFileName: The name of the file to add the row to.
- Example:
```
mod.AddStatRow(new object[] {
    "Player1",
    100
}, "PlayerStats");
```
FormatValue
- Converts a value to a CSV-compatible string format. This is automatically done by the AddStatRow method.

`Main` Class

Methods

RegisterCSVFile
- Registers a CSV file for ModUI toggles
- Parameters:
  - csvFileName: The name of the CSV file to register.

Example Mod

using MelonLoader;
using RumbleStats;
//other references...

namespace MyMod
{
    public class Main : MelonMod
    {
        StatsMod mod  = new StatsMod();
    
        public override void OnLateInitializeMelon()
        {
            mod.ModName = "MyModName";
            mod.storeEntryTime = true; //Stores entry timestamps when calling AddStatRow
            mod.storeEntryTime = false; //Does not store entry timestamps when calling AddStatRow
        
            var columns = new Dictionary<string, Type>
            {
                { "Column1Name", typeof(string) },
                { "Column2Name", typeof(int) },
                { "Column3Name", typeof(bool) },
                //etc...
            };
            
            mod.InitializeStatFile("CSVFileName", columns);
            RumbleStats.Main.instance.RegisterCSVFile("CSVFileName");

            RumbleStats.Main.instance.RegisterMod(mod);
            //Do this for each CSV file you want to store stats for...
        }
    
        private void SomeRandomMethod()
        {
            mod.AddStatRow(new object[]
            {
                "Stat1",
                1000101,
                true,
                //etc, same as the columns provided in the InitializeStatFile method...
            }, "CSVFileName");

            var rows = mod.GetAllRows("CSVFileName", skipHeader: true);
            foreach (var row in rows)
            {
                MelonLogger.Msg(string.Join(", ", row));
            }
        }
    }
}

Documentation

StatsMod Class

Properties

ModName: Name of the mod for indentifying and organizing data files.

storeEntryTime: Boolean value to include timestamps for each entry.

DebugMode: Boolean value to enable debug mode (logging to console).

Methods

InitializeStatFile

Creates a new CSV file with specified columns.
Parameters:
- fileName: Name of the CSV file.
- columns: Dictionary (string, type) of column names and their data types.

Example:

var columns = new Dictionary<string, Type>
{
    { "Player Name", typeof(string) },
    { "Battle Points", typeof(int) }
};
mod.InitializeStatFile("PlayerStats", columns);

StatFileExists

Checks if a specific stat file exists.
Returns: true if the file exists, otherwise false.

GetAllRows

Reads all rows from a CSV file.
Parameters:
- csvFileName: The name of the file to read.
- skipHeader: Boolean value to skip the header row.
Returns: A list of string arrays representing rows.

AddStatRow

Adds a new row to the CSV file.
Parameters:
- values: Array of object values for the row. Make sure they match the column types defined in the CSV file, in the same order, and the same amount of values.
- csvFileName: The name of the file to add the row to.

Example:

mod.AddStatRow(new object[] {
    "Player1",
    100
}, "PlayerStats");

FormatValue

Converts a value to a CSV-compatible string format. This is automatically done by the AddStatRow method.

Main Class

Methods

RegisterCSVFile

Registers a CSV file for ModUI toggles
Parameters:
- csvFileName: The name of the CSV file to register.

Example Mod

using MelonLoader; using RumbleStats; //other references... namespace MyMod { public class Main : MelonMod { StatsMod mod = new StatsMod(); public override void OnLateInitializeMelon() { mod.ModName = "MyModName"; mod.storeEntryTime = true; //Stores entry timestamps when calling AddStatRow mod.storeEntryTime = false; //Does not store entry timestamps when calling AddStatRow var columns = new Dictionary<string, Type> { { "Column1Name", typeof(string) }, { "Column2Name", typeof(int) }, { "Column3Name", typeof(bool) }, //etc... }; mod.InitializeStatFile("CSVFileName", columns); RumbleStats.Main.instance.RegisterCSVFile("CSVFileName"); RumbleStats.Main.instance.RegisterMod(mod); //Do this for each CSV file you want to store stats for... } private void SomeRandomMethod() { mod.AddStatRow(new object[] { "Stat1", 1000101, true, //etc, same as the columns provided in the InitializeStatFile method... }, "CSVFileName"); var rows = mod.GetAllRows("CSVFileName", skipHeader: true); foreach (var row in rows) { MelonLogger.Msg(string.Join(", ", row)); } } } }

Details

Installation Instructions

How to Use

Documentation

StatsMod Class

Properties

Methods

Main Class

Methods

Example Mod

Installation Instructions

How to Use

Documentation

StatsMod Class

Properties

Methods

Main Class

Methods

Example Mod

`StatsMod` Class

`Main` Class

`StatsMod` Class

`Main` Class