Modrify

0.0.3

EN-US/Modrify.dll-Help.xml

                                <?xml version="1.0" encoding="utf-8"?>

<helpItems schema="maml" xmlns="http://msh">

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Get-ModLoadOrder</command:name>

      <command:verb>Get</command:verb>

      <command:noun>ModLoadOrder</command:noun>

      <maml:description>

        <maml:para>Returns the sorted load order for the selected game.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Returns the sorted load order for the selected game. First mod loaded is the first mod in this array.</maml:para>

      <maml:para>For example, in Skyrim Skyrim.esm is the first item in this list.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-ModLoadOrder</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters />

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>Mutagen.Bethesda.Plugins.Order.ILoadOrderGetter`1[[Mutagen.Bethesda.Plugins.Order.IModListingGetter`1[[Mutagen.Bethesda.Plugins.Records.IModGetter, Mutagen.Bethesda.Core, Version=0.42.0.0, Culture=neutral, PublicKeyToken=null]], Mutagen.Bethesda.Core, Version=0.42.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>Get-ModLoadOrder</dev:code>

        <dev:remarks>

          <maml:para>Returns the load order.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Get-ModPriorityOrder</command:name>

      <command:verb>Get</command:verb>

      <command:noun>ModPriorityOrder</command:noun>

      <maml:description>

        <maml:para>Returns the selected game's load order reversed.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Assuming Set-ModrifyGame has been run, this will return the current game's load order reversed, which means the last mod loaded is the first mod in the returned array.</maml:para>

      <maml:para>For example, in Skyrim Skyrim.esm is last in the returned array.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-ModPriorityOrder</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters />

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>System.Collections.Generic.IEnumerable`1[[Mutagen.Bethesda.Plugins.Order.IModListingGetter`1[[Mutagen.Bethesda.Plugins.Records.IModGetter, Mutagen.Bethesda.Core, Version=0.42.0.0, Culture=neutral, PublicKeyToken=null]], Mutagen.Bethesda.Core, Version=0.42.0.0, Culture=neutral, PublicKeyToken=null]]</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>Get-ModPriorityOrder</dev:code>

        <dev:remarks>

          <maml:para>Returns the reversed load order.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Get-ModrifyGame</command:name>

      <command:verb>Get</command:verb>

      <command:noun>ModrifyGame</command:noun>

      <maml:description>

        <maml:para>Returns the GameEnvironment object created by Set-ModrifyGame.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>The GameEnvironment object created by Set-ModrifyGame has a lot of useful information about your game including the data folder path, the load order file path, and your load order.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Get-ModrifyGame</maml:name>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters />

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>Mutagen.Bethesda.Environments.IGameEnvironment</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>Get-ModrifyGame</dev:code>

        <dev:remarks>

          <maml:para>As simple as it comes, returns the GameEnvironment object.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

  <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">

    <command:details>

      <command:name>Set-ModrifyGame</command:name>

      <command:verb>Set</command:verb>

      <command:noun>ModrifyGame</command:noun>

      <maml:description>

        <maml:para>The first command to run for any work in Modrify. This sets your game environment to be the specified game.</maml:para>

      </maml:description>

    </command:details>

    <maml:description>

      <maml:para>Modrify supports several game releases that are supported by Mutagen. In order to know which game to work with, you specify that with this command.</maml:para>

    </maml:description>

    <command:syntax>

      <command:syntaxItem>

        <maml:name>Set-ModrifyGame</maml:name>

        <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

          <maml:name>Game</maml:name>

          <maml:description>

            <maml:para>The game to be referenced. Not all games supported by Mutagen are yet supported by Modrify.</maml:para>

            <maml:para>Options are:</maml:para>

            <maml:para>Oblivion SkyrimLE SkyrimSE SkyrimVR Fallout4 EnderalLE EnderalSE SkyrimSEGog</maml:para>

          </maml:description>

          <command:parameterValueGroup>

            <command:parameterValue required="false" command:variableLength="false">Oblivion</command:parameterValue>

            <command:parameterValue required="false" command:variableLength="false">SkyrimLE</command:parameterValue>

            <command:parameterValue required="false" command:variableLength="false">SkyrimSE</command:parameterValue>

            <command:parameterValue required="false" command:variableLength="false">SkyrimVR</command:parameterValue>

            <command:parameterValue required="false" command:variableLength="false">Fallout4</command:parameterValue>

            <command:parameterValue required="false" command:variableLength="false">EnderalLE</command:parameterValue>

            <command:parameterValue required="false" command:variableLength="false">EnderalSE</command:parameterValue>

            <command:parameterValue required="false" command:variableLength="false">SkyrimSEGog</command:parameterValue>

          </command:parameterValueGroup>

          <command:parameterValue required="true" variableLength="false">GameRelease</command:parameterValue>

          <dev:type>

            <maml:name>GameRelease</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>None</dev:defaultValue>

        </command:parameter>

        <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

          <maml:name>PassThru</maml:name>

          <maml:description>

            <maml:para>Will return the GameEnvironment object.</maml:para>

          </maml:description>

          <dev:type>

            <maml:name>SwitchParameter</maml:name>

            <maml:uri />

          </dev:type>

          <dev:defaultValue>False</dev:defaultValue>

        </command:parameter>

      </command:syntaxItem>

    </command:syntax>

    <command:parameters>

      <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none">

        <maml:name>Game</maml:name>

        <maml:description>

          <maml:para>The game to be referenced. Not all games supported by Mutagen are yet supported by Modrify.</maml:para>

          <maml:para>Options are:</maml:para>

          <maml:para>Oblivion SkyrimLE SkyrimSE SkyrimVR Fallout4 EnderalLE EnderalSE SkyrimSEGog</maml:para>

        </maml:description>

        <command:parameterValue required="true" variableLength="false">GameRelease</command:parameterValue>

        <dev:type>

          <maml:name>GameRelease</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>None</dev:defaultValue>

      </command:parameter>

      <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none">

        <maml:name>PassThru</maml:name>

        <maml:description>

          <maml:para>Will return the GameEnvironment object.</maml:para>

        </maml:description>

        <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>

        <dev:type>

          <maml:name>SwitchParameter</maml:name>

          <maml:uri />

        </dev:type>

        <dev:defaultValue>False</dev:defaultValue>

      </command:parameter>

    </command:parameters>

    <command:inputTypes>

      <command:inputType>

        <dev:type>

          <maml:name>None</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:inputType>

    </command:inputTypes>

    <command:returnValues>

      <command:returnValue>

        <dev:type>

          <maml:name>Mutagen.Bethesda.Environments.IGameEnvironment</maml:name>

        </dev:type>

        <maml:description>

          <maml:para></maml:para>

        </maml:description>

      </command:returnValue>

    </command:returnValues>

    <maml:alertSet>

      <maml:alert>

        <maml:para></maml:para>

      </maml:alert>

    </maml:alertSet>

    <command:examples>

      <command:example>

        <maml:title>-------------------------- Example 1 --------------------------</maml:title>

        <dev:code>Set-ModrifyGame SkyrimSE</dev:code>

        <dev:remarks>

          <maml:para>Sets the game environment to be Skyrim Special Edition.</maml:para>

        </dev:remarks>

      </command:example>

    </command:examples>

    <command:relatedLinks />

  </command:command>

</helpItems>