diff options
author | BobTheBob <32057864+BobTheBob9@users.noreply.github.com> | 2022-08-24 00:32:31 +0100 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-08-24 00:32:31 +0100 |
commit | f9bc3c9d1834cb8bd5f872b749b057c33e8b0102 (patch) | |
tree | e96e2da0d95798dd42eddf644a82a74555db858f /NorthstarDLL/modmanager.h | |
parent | 812893d8219daa60f5b5b7fd22cbd6b175603399 (diff) | |
download | NorthstarLauncher-f9bc3c9d1834cb8bd5f872b749b057c33e8b0102.tar.gz NorthstarLauncher-f9bc3c9d1834cb8bd5f872b749b057c33e8b0102.zip |
Adjust folder structure (#242)
* Adjust folder structure
* change launcher directory name
Diffstat (limited to 'NorthstarDLL/modmanager.h')
-rw-r--r-- | NorthstarDLL/modmanager.h | 156 |
1 files changed, 156 insertions, 0 deletions
diff --git a/NorthstarDLL/modmanager.h b/NorthstarDLL/modmanager.h new file mode 100644 index 00000000..d605eec2 --- /dev/null +++ b/NorthstarDLL/modmanager.h @@ -0,0 +1,156 @@ +#pragma once +#include "convar.h" +#include <string> +#include <vector> +#include <filesystem> +#include "rapidjson/document.h" +#include "memalloc.h" + +namespace fs = std::filesystem; + +const std::string MOD_FOLDER_SUFFIX = "/mods"; +const fs::path MOD_OVERRIDE_DIR = "mod"; +const std::string COMPILED_ASSETS_SUFFIX = "/runtime/compiled"; + +struct ModConVar +{ + public: + std::string Name; + std::string DefaultValue; + std::string HelpString; + int Flags; +}; + +struct ModScriptCallback +{ + public: + // would've liked to make it possible to hook arbitrary codecallbacks, but couldn't find a function that calls some ui ones + // std::string HookedCodeCallback; + + ScriptContext Context; + + // called before the codecallback is executed + std::string BeforeCallback; + // called after the codecallback has finished executing + std::string AfterCallback; +}; + +struct ModScript +{ + public: + std::string Path; + std::string RsonRunOn; + + std::vector<ModScriptCallback> Callbacks; +}; + +// these are pretty much identical, could refactor to use the same stuff? +struct ModVPKEntry +{ + public: + bool m_bAutoLoad; + std::string m_sVpkPath; +}; + +struct ModRpakEntry +{ + public: + bool m_bAutoLoad; + std::string m_sPakName; + std::string m_sLoadAfterPak; +}; + +class Mod +{ + public: + // runtime stuff + fs::path ModDirectory; + bool Enabled = true; + + // mod.json stuff: + + // the mod's name + std::string Name; + // the mod's description + std::string Description; + // the mod's version, should be in semver + std::string Version; + // a download link to the mod, for clients that try to join without the mod + std::string DownloadLink; + + // whether clients need the mod to join servers running this mod + bool RequiredOnClient; + // the priority for this mod's files, mods with prio 0 are loaded first, then 1, then 2, etc + int LoadPriority; + + // custom scripts used by the mod + std::vector<ModScript> Scripts; + // convars created by the mod + std::vector<ModConVar*> ConVars; + // custom localisation files created by the mod + std::vector<std::string> LocalisationFiles; + + // other files: + + std::vector<ModVPKEntry> Vpks; + std::unordered_map<size_t, std::string> KeyValues; + std::vector<std::string> BinkVideos; + std::string Pdiff; // only need one per mod + + std::vector<ModRpakEntry> Rpaks; + std::unordered_map<std::string, std::string> + RpakAliases; // paks we alias to other rpaks, e.g. to load sp_crashsite paks on the map mp_crashsite + // iterated over to create squirrel VM constants depending if a mod exists or not. + // this only exists because we cannot access g_ModManager whilst mods are being loaded for the first time for some reason. + std::unordered_map<std::string, std::string> DependencyConstants; + + // other stuff + + bool wasReadSuccessfully = false; + + public: + Mod(fs::path modPath, char* jsonBuf); +}; + +struct ModOverrideFile +{ + public: + Mod* owningMod; + fs::path path; +}; + +class ModManager +{ + private: + bool m_hasLoadedMods = false; + bool m_hasEnabledModsCfg; + rapidjson_document m_enabledModsCfg; + + // precalculated hashes + size_t m_hScriptsRsonHash; + size_t m_hPdefHash; + + public: + std::vector<Mod> m_loadedMods; + std::unordered_map<std::string, ModOverrideFile> m_modFiles; + // iterated over to create squirrel VM constants depending if a mod exists or not. + // here because constants are global anyways. + std::unordered_map<std::string, std::string> DependencyConstants; + + public: + ModManager(); + void LoadMods(); + void UnloadMods(); + void CompileAssetsForFile(const char* filename); + + // compile asset type stuff, these are done in files under Mods/Compiled/ + void BuildScriptsRson(); + void TryBuildKeyValues(const char* filename); + void BuildPdef(); +}; + +void InitialiseModManager(HMODULE baseAddress); +fs::path GetModFolderPath(); +fs::path GetCompiledAssetsPath(); + +extern ModManager* g_ModManager;
\ No newline at end of file |