New store Example mod

Who: For modders to use as an example when making their own "Safehouse Progression Mode" config mods.

What: Contains these README instructions, a sample shRnk_defaultRanks.json file, an icon.png, and manifest.json. The knviesStore.png is the image that will show in the itemshop and players will click on to get to your store. The sufficient resources for a newbie modder to copy the entire folder and make their own mod from.

When: NOW!

Where: If using R2ModMan (aka R2MM) you can find this folder under the path: "C:\Users\<USER>\AppData\Roaming\r2modmanPlus-local\H3VR\profiles\<PROFILE_NAME>\BepInEx\plugins\NGA-SPM_NewStore_Example"

Why

Suppose you've really gotten into 'themes' and now you want to make a Store, like say, a store that only sells specific categories of items, like say, SMGs etc, but you Don't care about tags like 'Soviet era', because the dev didn't have time to implement that. Well this is the sample mod for you! You can make an IKEA store, an Optics-only store, whatever.

Details

{
    "displayName": "Rekki's Relished Firearms",
    "modFolderName": "NGA-SafehouseProgressionModeCode_Beta",
    "iconFileName": "rekkiStoreIcon.png",
    "allowedPageModes": [
        1,3
    ],
    "disallowedSubCats": [
        49, 57, 62, 100, 101, 102, 103, 104, 105, 106, 107, 108, 109
    ]
}

• There must be one file per "Store" you want to add, and each one has these top-level fields:
  • displayName: Player-visible (not actully) name of the store.
  • modFolderName: The folder name of the mod in format Author-ModName, so for this sample mod it's NGA-SPM_LevelRewards_Example.
  • iconFileName: Player-visible icon shown in the item shop that players click on, like knviesStore.png.
    • The icon should be about 570x220px, and it has to be a png.
  • allowedPageModes: (Required) List of enum ints from which item subcategories below will come, like "Firearms" is 1.
    • See appendix for full list in PageMode.
  • exclusiveSubCats: (Optional) List of enum ints of the only categories within each page which are allowed to be sold; for example, "Automatic Pistol" is 1.
    • See appendix for full list in ItemSpawnerID.ESubCategory.
  • disallowedSubCats: (Optional) List of enum ints of categories which are blocked, assuming you didn't populate exclusiveSubCats above, otherwise they're ignored.
    • See appendix for full list in ItemSpawnerID.ESubCategory.

Appendix

These are the relevant H3VR enums copied over.

public enum PageMode
{
  MainMenu,
  Firearms,
  Ammo,
  Attachments,
  Melee,
  ToolsToys,
  ReservedForNextYearDontTouch,
  Saved,
  Help
}

public enum ESubCategory
{
    None,
    AutomaticPistol,
    Revolver,
    MachinePistol,
    BreakActionShotgun,
    TubeFedShotgun,
    MagazineFedShotgun,
    SMG,
    PDW,
    LeverActionRifle,
    Carbine,
    AssaultRifle,
    BattleRifle,
    BoltActionRifle,
    AntiMaterial,
    Grenade,
    Machinegun,
    Ordnance,
    IronSight,
    ReflexSight,
    Magnifier_Scope,
    Suppressor,
    Laser_Light,
    RailAdapter,
    Decorative,
    Tactical,
    Improvised,
    Thrown,
    Utility,
    Target,
    Horseshoe,
    TippyToy,
    Firework,
    BreechloadingHandgun,
    LeverActionHandgun,
    LeverActionShotgun,
    Garage,
    PowerTools,
    Medieval,
    GoofyMelee,
    FarmTools,
    Shields,
    BoltActionPistol,
    Foregrip,
    Stock,
    Backpack,
    Bayonet,
    UnderBarrelWeapon,
    BangerJunk,
    RailHat,
    MuzzleLoadedPistol,
    Derringer,
    BreechloadingRifle,
    MuzzleLoadedRifle,
    Bipods,
    MuzzleBrakes,
    MuzzleAdapters,
    Sosigguns,
    GrenadeLaunchers,
    RocketMissileLaunchers,
    LocomotionGuns,
    RemoteExplosives,
    Exotic,
    Barrier,
    SteelTarget,
    DestructibleTarget,
    Prop,
    Furniture,
    Primitive,
    HeadMounted,
    Signals,
    Controls,
    Widgets,
    Sosiggrenade = 80,
    Sosigmelee,
    MF_Scout = 100,
    MF_Soldier,
    MF_Pyro,
    MF_Demo,
    MF_Heavy,
    MF_Engineer,
    MF_Medic,
    MF_Sniper,
    MF_Spy,
    MF_Generic
}