Static Public Member Functions
static void	Verify ()
	Verifies that the file hierarchy is correct, creates missing directories and files if needed. More...

Static Public Attributes
const string	MY_MODS_FILE_NAME = "MySemiMods.txt"
	The name of the file that determines mods to ignore during validation. More...

const string	MODS_FOLDER_NAME = "SemiMods"
	The name of the folder inside the game folder from where mods are loaded. More...

const string	MODS_ORDER_FILE_NAME = "order.txt"
	The name of the text file that specifies what order mods should be loaded in first, before any unspecified mods that remain are loaded in default/filesystem order. More...

const string	MODS_BLACKLIST_FILE_NAME = "blacklist.txt"
	The name of the text file that specifies what mods should never be loaded, even if they are defined in the order list. More...

const string	MODS_CACHE_FOLDER_NAME = "Cache"
	The name of the folder where all cached data related to mods is stored. More...

const string	MODS_CACHE_RELINK_FOLDER_NAME = "RelinkedAssemblies"
	The name of the folder inside the mod cache folder where relinked assemblies are stored. More...

const string	MOD_INFO_FILE_NAME = "mod.yml"
	The name of the mod metadata file. More...

Properties
static string	GameFolder `[get]`
	Gets the absolute path to the root folder that all the game data resides in. More...

static string	ManagedFolder `[get]`
	Gets the absolute path to the folder where all the .NET assemblies reside in. More...

static string	MyModsFile `[get]`
	Gets the absolute path to the file listing mods to ignore during checksum validation. More...

static string	ModsFolder `[get]`
	Gets the absolute path to the folder where mods are loaded from. More...

static string	ModsOrderFile `[get]`
	Gets the absolute path to the file that specifies priority mod loading order. More...

static string	ModsBlacklistFile `[get]`
	Gets the absolute path to the file that specifies which mods to never load. More...

static string	ModsCacheFolder `[get]`
	Gets the absolute path to the folder that houses all cached data related to mods. More...

static string	ModsCacheRelinkFolder `[get]`
	Gets the absolute path to the folder that houses mod assemblies after they've been relinked to reroute references to MonoMod patch assemblies into the main game assembly. More...

Static Private Attributes
static string	_GameFolder

static string	_ManagedFolder

static string	_MyModsFile

static string	_ModsFolder

static string	_ModsOrderFile

static string	_ModsBlacklistFile

static string	_ModsCacheFolder

static string	_ModsCacheRelinkFolder

const string	ORDER_TXT_DEFAULT_TEXT = "# put names of mod folders/archives to be loaded in a specific order here\n# mods that aren't in this file will also be loaded,\n# but in unspecified order"

const string	BLACKLIST_TXT_DEFAULT_TEXT = "# put names of mod folders/archives that you don't want loaded here\n# this file will override the order.txt file if necessary"

const string	MY_MODS_TXT_DEFAULT_TEXT = "# put IDs of mods that you're working on\n# to allow them to load without validating the online checksum\n# do not trust anybody telling you to put in their mod here if you haven't written it,\n# as they could be trying to work around the security features to make you run a malicious mod\n\n"

Member Function Documentation

◆ Verify()

static void Semi.FileHierarchy.Verify ( )

inlinestatic

Verifies that the file hierarchy is correct, creates missing directories and files if needed.

Member Data Documentation

◆ _GameFolder

string Semi.FileHierarchy._GameFolder

staticprivate

◆ _ManagedFolder

string Semi.FileHierarchy._ManagedFolder

staticprivate

◆ _ModsBlacklistFile

string Semi.FileHierarchy._ModsBlacklistFile

staticprivate

◆ _ModsCacheFolder

string Semi.FileHierarchy._ModsCacheFolder

staticprivate

◆ _ModsCacheRelinkFolder

string Semi.FileHierarchy._ModsCacheRelinkFolder

staticprivate

◆ _ModsFolder

string Semi.FileHierarchy._ModsFolder

staticprivate

◆ _ModsOrderFile

string Semi.FileHierarchy._ModsOrderFile

staticprivate

◆ _MyModsFile

string Semi.FileHierarchy._MyModsFile

staticprivate

◆ BLACKLIST_TXT_DEFAULT_TEXT

const string Semi.FileHierarchy.BLACKLIST_TXT_DEFAULT_TEXT = "# put names of mod folders/archives that you don't want loaded here\n# this file will override the order.txt file if necessary"

staticprivate

◆ MOD_INFO_FILE_NAME

const string Semi.FileHierarchy.MOD_INFO_FILE_NAME = "mod.yml"

static

The name of the mod metadata file.

◆ MODS_BLACKLIST_FILE_NAME

const string Semi.FileHierarchy.MODS_BLACKLIST_FILE_NAME = "blacklist.txt"

static

The name of the text file that specifies what mods should never be loaded, even if they are defined in the order list.

◆ MODS_CACHE_FOLDER_NAME

const string Semi.FileHierarchy.MODS_CACHE_FOLDER_NAME = "Cache"

static

The name of the folder where all cached data related to mods is stored.

◆ MODS_CACHE_RELINK_FOLDER_NAME

const string Semi.FileHierarchy.MODS_CACHE_RELINK_FOLDER_NAME = "RelinkedAssemblies"

static

The name of the folder inside the mod cache folder where relinked assemblies are stored.

◆ MODS_FOLDER_NAME

const string Semi.FileHierarchy.MODS_FOLDER_NAME = "SemiMods"

static

The name of the folder inside the game folder from where mods are loaded.

◆ MODS_ORDER_FILE_NAME

const string Semi.FileHierarchy.MODS_ORDER_FILE_NAME = "order.txt"

static

The name of the text file that specifies what order mods should be loaded in first, before any unspecified mods that remain are loaded in default/filesystem order.

◆ MY_MODS_FILE_NAME

const string Semi.FileHierarchy.MY_MODS_FILE_NAME = "MySemiMods.txt"

static

The name of the file that determines mods to ignore during validation.

◆ MY_MODS_TXT_DEFAULT_TEXT

const string Semi.FileHierarchy.MY_MODS_TXT_DEFAULT_TEXT = "# put IDs of mods that you're working on\n# to allow them to load without validating the online checksum\n# do not trust anybody telling you to put in their mod here if you haven't written it,\n# as they could be trying to work around the security features to make you run a malicious mod\n\n"

staticprivate

◆ ORDER_TXT_DEFAULT_TEXT

const string Semi.FileHierarchy.ORDER_TXT_DEFAULT_TEXT = "# put names of mod folders/archives to be loaded in a specific order here\n# mods that aren't in this file will also be loaded,\n# but in unspecified order"

staticprivate

Property Documentation

◆ GameFolder

string Semi.FileHierarchy.GameFolder

staticget

Gets the absolute path to the root folder that all the game data resides in.

The game folder.

◆ ManagedFolder

string Semi.FileHierarchy.ManagedFolder

staticget

Gets the absolute path to the folder where all the .NET assemblies reside in.

The Managed folder.

◆ ModsBlacklistFile

string Semi.FileHierarchy.ModsBlacklistFile

staticget

Gets the absolute path to the file that specifies which mods to never load.

The mods blacklist file.

◆ ModsCacheFolder

string Semi.FileHierarchy.ModsCacheFolder

staticget

Gets the absolute path to the folder that houses all cached data related to mods.

The mods cache folder.

◆ ModsCacheRelinkFolder

string Semi.FileHierarchy.ModsCacheRelinkFolder

staticget

Gets the absolute path to the folder that houses mod assemblies after they've been relinked to reroute references to MonoMod patch assemblies into the main game assembly.

The mod relink cache folder.

◆ ModsFolder

string Semi.FileHierarchy.ModsFolder

staticget

Gets the absolute path to the folder where mods are loaded from.

The mods folder.

◆ ModsOrderFile

string Semi.FileHierarchy.ModsOrderFile

staticget

Gets the absolute path to the file that specifies priority mod loading order.

The mods order file.

◆ MyModsFile

string Semi.FileHierarchy.MyModsFile

staticget

Gets the absolute path to the file listing mods to ignore during checksum validation.

The documentation for this class was generated from the following file:

Semi/src/Semi/FileHierarchy.cs

Static Public Member Functions

Static Public Attributes

Properties

Static Private Attributes

Member Function Documentation

◆ Verify()

Member Data Documentation

◆ _GameFolder

◆ _ManagedFolder

◆ _ModsBlacklistFile

◆ _ModsCacheFolder

◆ _ModsCacheRelinkFolder

◆ _ModsFolder

◆ _ModsOrderFile

◆ _MyModsFile

◆ BLACKLIST_TXT_DEFAULT_TEXT

◆ MOD_INFO_FILE_NAME

◆ MODS_BLACKLIST_FILE_NAME

◆ MODS_CACHE_FOLDER_NAME

◆ MODS_CACHE_RELINK_FOLDER_NAME

◆ MODS_FOLDER_NAME

◆ MODS_ORDER_FILE_NAME

◆ MY_MODS_FILE_NAME

◆ MY_MODS_TXT_DEFAULT_TEXT

◆ ORDER_TXT_DEFAULT_TEXT

Property Documentation

◆ GameFolder

◆ ManagedFolder

◆ ModsBlacklistFile

◆ ModsCacheFolder

◆ ModsCacheRelinkFolder

◆ ModsFolder

◆ ModsOrderFile

◆ MyModsFile