_NickCore

If you're a mod user and a mod has _NickCore as one of its requirements, all you need to know is that you need to install this mod using Fluffy Mod Manager. When installing it, make sure the text log at the bottom left tells you it has actually been installed. If it says no files were installed, download this mod again and reinstall it.

If you're a mod author and want to use this, keep reading.

Installed mods tracking

If you add a ModName.json file to data/_NickCore/Installed, a global variable called ModName_installed will be set to true and available to all scripts in your autorun folder. This should streamline compatibility between mods.

File list

_NickCore/Files returns fs.glob("."), which is a lua table with the paths to all files in the data folder. Having this accessible globally means no other mods should need to call fs.glob, which is extremely performance intensive. Note that you need to then filter the files paths, but this is orders of magnitude faster than fs.glob.

Startup tools

_NickCore/Startup gives you access to two functions for when you want to modify data when the game starts.

• []is_startup(): returns true so long as a script reset hasn't been performed yet. Use it to modify game data only when the game starts and not on successive script resets.[/]

  []is_game_data_ready(delay): returns true if all the game data has finished loading so you can modify it. If delay is provided, it will wait that additional amount of time (in seconds) before returning true.[/]

  Shared properties table

  _NickCore/Properties gives you a table of game and player properties. Dozens of mods collect these, sometimes every frame. _NickCore does all of that for you, which means it only needs to be done once. Check the articles section for which properties are collected.

  Timer handling

  _NickCore/Timers gives you the following functions to streamline setting timers:

  • []set_timer(delay,fn): calls fn after delay in seconds, and returns the timer key. The timer accounts for differences in FPS automatically, and won't run while the game is paused.[/]

    []cancel_timer(key): cancels the timer associated with key.[/]

    []end_timer(key): ends the timer associated with key, triggering the corresponding function early.

    Shared functions table with hooks

    _NickCore/Functions gives you a table of tables of functions that are run in different hooks. Dozens of mods hook methods like requestActionCore and calcDamageValue. Having dozens of hooks like that doing calculations can cause performance issues. _NickCore centralizes those hooks: it'll hook the methods and run all functions in a shared functions table each time the method gets c