radj307 / alch-registry-generator

Mutagen utility for generating a list of all ingredients present in a load order that can be used with https://github.com/radj307/alch
0 stars 0 forks source link
alch alch-registry-generator generator mutagen utility

alch Registry Generator

https://github.com/radj307/caco-alch-potion-builder

This is the utility used to generate the ingredients registry for my CLI potion builder / general alchemy utility project.
Uses the Mutagen library.

Usage

With a Mod Manager

The process for Vortex is probably similar, but I've never used it so I don't know.

  1. Extract the latest release to a directory of your choice.

  2. Add alch-registry-generator.exe as an external executable. The following table explains what each field does:

    Field Description
    Title Your choice, this is the name that appears in the executable list.
    Binary The path to alch-registry-generator.exe
    Start In Your desired output directory.
    Arguments Space-separated list of arguments. See here for a list of valid arguments.

    Here is an example: (Note: Executable name is alch-registry-generator.exe as of v2.0.1)

  3. Run the executable through your mod manager.

Manual

_Note: This method will only include manually-installed mods, if you use a mod manager, see above._

  1. Extract the latest release to a directory of your choice.
  2. Run alch-registry-generator.exe by opening a terminal in the same directory, or by double-clicking it.

Specifying the Output Directory

There are 2 ways to accomplish this without using a mod manager:

Using the Terminal

  1. Open a terminal session
  2. cd to your desired output directory.
  3. Call the program by using its absolute path.

Using a Shortcut

  1. R+Click on alch-registry-generator.exe and select Create Shortcut.
  2. R+Click on the shortcut, select Properties.
  3. Put your desired output directory in the box next to Start In.

Commandline Options

Option Description
-n --no-pause Allows the program to exit without prompting the user for input.
-o <name> --output <name> Specify the name of the output file.