Public Member Functions
	Companion (std::filesystem::path rom, const ArchiveType otr, const bool debug, const bool modding=false, const std::string &srcDir="", const std::string &destPath="")
	Companion (std::vector< uint8_t > rom, const ArchiveType otr, const bool debug, const bool modding=false, const std::string &srcDir="", const std::string &destPath="")
void	SetRomPath (std::filesystem::path path)
	Companion (std::filesystem::path rom, const ArchiveType otr, const bool debug, const std::string &srcDir="", const std::string &destPath="")
	Companion (std::vector< uint8_t > rom, const ArchiveType otr, const bool debug, const std::string &srcDir="", const std::string &destPath="")
void	Init (ExportType type)
void	Init (ExportType type, std::atomic< size_t > &assetCount, bool shouldProcess)
bool	NodeHasChanges (const std::string &string)
void	Process (std::atomic< size_t > &assetCount)
bool	IsOTRMode () const
bool	IsDebug () const
bool	AddTextureDefines () const
N64::Cartridge *	GetCartridge () const
const std::string &	GetGameTitle () const
std::vector< uint8_t > &	GetRomData ()
std::string	GetOutputPath ()
const std::string &	GetAssetPath () const
std::string	GetDestRelativeOutputPath ()
GBIVersion	GetGBIVersion () const
GBIMinorVersion	GetGBIMinorVersion () const
std::unordered_map< std::string, std::vector< YAML::Node > >	GetCourseMetadata ()
std::optional< std::string >	GetEnumFromValue (const std::string &key, int id)
bool	IsUsingIndividualIncludes () const
std::optional< ParseResultData >	GetParseDataByAddr (uint32_t addr)
std::optional< ParseResultData >	GetParseDataBySymbol (const std::string &symbol)
std::optional< std::uint32_t >	GetFileOffsetFromSegmentedAddr (uint8_t segment) const
std::optional< std::pair< std::uint32_t, std::uint32_t > >	GetFileOffsetFromCompressedSegmentedAddr (uint8_t segment) const
std::optional< std::shared_ptr< BaseFactory > >	GetFactory (const std::string &type)
uint32_t	PatchVirtualAddr (uint32_t addr)
ResolvedAddr	ResolveVirtualAddr (uint32_t addr)
std::optional< std::tuple< std::string, YAML::Node > >	GetNodeByAddr (uint32_t addr)
std::optional< std::tuple< std::string, YAML::Node > >	GetNodeByAddr (uint32_t addr, const std::string &file)
std::optional< std::string >	GetStringByAddr (uint32_t addr)
std::optional< std::tuple< std::string, YAML::Node > >	GetSafeNodeByAddr (const uint32_t addr, std::string type)
std::optional< std::string >	GetSafeStringByAddr (const uint32_t addr, std::string type)
std::optional< std::vector< std::tuple< std::string, YAML::Node > > >	GetNodesByType (const std::string &type, bool includeAutogen=false)
const std::vector< std::tuple< std::string, YAML::Node > > *	GetNodesByTypeRef (const std::string &type, bool includeAutogen=false)
std::string	GetSymbolFromAddr (uint32_t addr, bool validZero=false)
std::optional< std::uint32_t >	GetFileOffset (void) const
std::optional< std::uint32_t >	GetCurrSegmentNumber (void) const
CompressionType	GetCurrCompressionType (void) const
std::optional< std::uint32_t >	GetCurrentCompressedSize (void) const
std::optional< VRAMEntry >	GetCurrentVRAM (void) const
std::optional< Table >	SearchTable (uint32_t addr)
std::string	NormalizeAsset (const std::string &name) const
std::string	RelativePath (const std::string &path) const
std::string	RelativePathToSrcDir (const std::string &path) const
std::string	RelativePathToDestDir (const std::string &path) const
void	RegisterCompanionFile (const std::string path, std::vector< char > data)
void	RegisterArchiveFile (const std::string &name, std::vector< char > data)
void	SetAdditionalFiles (const std::vector< std::string > &files)
void	SetVersion (const std::string &version)
std::string	GetCurrentAssetName () const
void	SetAssetTotal (std::atomic< size_t > *total)
void	SetPhaseCallback (std::function< void(int)> cb)
void	SetProcess (bool shouldProcess)
TorchConfig &	GetConfig ()
BinaryWrapper *	GetCurrentWrapper ()
const std::unordered_map< std::string, std::string > &	GetModdedAssetPaths () const
std::optional< std::tuple< std::string, YAML::Node > >	RegisterAsset (const std::string &name, YAML::Node &node)
std::optional< YAML::Node >	AddSubFileAsset (YAML::Node asset, std::string newFileName, CompressionType newCompressionType, uint32_t compressedSize=0)
std::optional< YAML::Node >	AddAsset (YAML::Node asset)
std::string	GetCurrentDirectory () const
void	SetCompressedSegment (uint32_t segmentId, uint32_t compressedFileOffset, uint32_t offset)
bool	GetCompressedSegmentOffset (uint32_t *addr)
void	SetSingleYMLPath (const std::string &path)

Static Public Member Functions
static std::vector< char >	ParseVersionString (const std::string &version)
static std::string	CalculateHash (const std::vector< uint8_t > &data)
static void	Pack (const std::string &folder, const std::string &output, const ArchiveType otrMode, const std::string &version="")

Static Public Attributes
static Companion *	Instance

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

src/Companion.h
src/Companion.cpp
src/main.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes