diff --git a/Dalamud/ClientLanguage.cs b/Dalamud/ClientLanguage.cs new file mode 100644 index 000000000..ddd69576d --- /dev/null +++ b/Dalamud/ClientLanguage.cs @@ -0,0 +1,28 @@ +namespace Dalamud +{ + /// + /// Enum describing the language the game loads in. + /// + public enum ClientLanguage + { + /// + /// Indicating a Japanese game client. + /// + Japanese, + + /// + /// Indicating an English game client. + /// + English, + + /// + /// Indicating a German game client. + /// + German, + + /// + /// Indicating a French game client. + /// + French, + } +} diff --git a/Dalamud/DalamudStartInfo.cs b/Dalamud/DalamudStartInfo.cs index 80b77d71c..89a57beb8 100644 --- a/Dalamud/DalamudStartInfo.cs +++ b/Dalamud/DalamudStartInfo.cs @@ -1,33 +1,54 @@ using System; -#pragma warning disable 1591 +#pragma warning disable SA1401 // Fields should be private -namespace Dalamud { +namespace Dalamud +{ + /// + /// Class containing information needed to initialize Dalamud. + /// [Serializable] public sealed class DalamudStartInfo { + /// + /// The working directory of the XIVLauncher installations. + /// public string WorkingDirectory; + + /// + /// The path to the configuration file. + /// public string ConfigurationPath; + /// + /// The path to the directory for installed plugins. + /// public string PluginDirectory; + + /// + /// The path to the directory for developer plugins. + /// public string DefaultPluginDirectory; + /// + /// The path to core Dalamud assets. + /// public string AssetDirectory; + /// + /// The language of the game client. + /// public ClientLanguage Language; + /// + /// The current game version code. + /// public string GameVersion; + /// + /// Whether or not market board information should be uploaded by default. + /// public bool OptOutMbCollection; } - - /// - /// Enum describing the language the game loads in. - /// - public enum ClientLanguage - { - Japanese, - English, - German, - French - } } + +#pragma warning restore SA1401 // Fields should be private