C# Class Nexus.Client.ModManagement.ReadMeManager

Public Methods

Method	Description
CheckModReadMe ( string p_strModName ) : string[]	Check if there's a readme file for the given mod.
CheckReadMeFolder ( ) : bool	Checks if the read me folder is already present, otherwise it tries to create it.
DeleteReadMe ( string p_strFileName ) : void	Deletes the readme file.
GetModReadMe ( string p_strModName, string p_strFileName ) : string	Get the ReadMe file path if it exists.
LoadReadMe ( ) : void	Check if the readme setup file is already present.
ReadMeManager ( string p_strFilePath ) : System	A simple constructor that initializes the ReadMeManager.
ReadVersion ( string p_strReadMePath ) : System.Version	Reads the ReadMe manager version from the given file.
SaveReadMeConfig ( ) : void	Save the data to the category file.
VerifyReadMeFile ( TxFileManager p_tfmFileManager, string p_strArchivePath ) : bool	Verifies if the readme file exists in the archive and saves it to the ReadMe folder.

Method	Description
CreateReadMeArchive ( string p_strArchiveFile, string p_strFilesToCompress ) : bool	Creates the readme files archive for the current mod.
PurgeTempFolder ( ) : void	Removes any file in the ReadMe/Temp folder.

Method	Description
GetFileList ( Archive p_arcArchive, bool p_booRecurse ) : List	Retrieves the list of all files in the specified folder.

Check if there's a readme file for the given mod.

public CheckModReadMe ( string p_strModName ) : string[]
p_strModName	string
return	string[]

Checks if the read me folder is already present, otherwise it tries to create it.

public CheckReadMeFolder ( ) : bool
return	bool

Creates the readme files archive for the current mod.

protected CreateReadMeArchive ( string p_strArchiveFile, string p_strFilesToCompress ) : bool
p_strArchiveFile	string	The archive name.
p_strFilesToCompress	string	The list of files to compress.
return	bool

Deletes the readme file.

public DeleteReadMe ( string p_strFileName ) : void
p_strFileName	string	The path where the ReadMe folder should be created.
return	void

Get the ReadMe file path if it exists.

public GetModReadMe ( string p_strModName, string p_strFileName ) : string
p_strModName	string
p_strFileName	string	The mod file name.
return	string

Check if the readme setup file is already present.

public LoadReadMe ( ) : void
return	void

Removes any file in the ReadMe/Temp folder.

protected PurgeTempFolder ( ) : void
return	void

A simple constructor that initializes the ReadMeManager.

public ReadMeManager ( string p_strFilePath ) : System
p_strFilePath	string	The path where the ReadMe folder should be created.
return	System

Reads the ReadMe manager version from the given file.

public static ReadVersion ( string p_strReadMePath ) : System.Version
p_strReadMePath	string
return	System.Version

Save the data to the category file.

public SaveReadMeConfig ( ) : void
return	void

Verifies if the readme file exists in the archive and saves it to the ReadMe folder.

public VerifyReadMeFile ( TxFileManager p_tfmFileManager, string p_strArchivePath ) : bool
p_tfmFileManager	ChinhDo.Transactions.TxFileManager
p_strArchivePath	string	The path to the mod archive.
return	bool