Skip to content

CLI Arguments

Mr Zombii edited this page Aug 13, 2025 · 5 revisions

Mod-Loading Arguments

--mod-folder

  • default-value: "./pmods"
  • required: False
  • description: When used, it changes the default mod-folder puzzle-loader-core reads from.
  • example: --mod-folder="path/to/your/mods/here"

--mod-paths

  • default-value: None
  • required: False
  • description: When used, it adds whatever files you provide to the class-path.
  • examples:
    1. --mod-paths="path/to/your/Jar.jar"
    2. --mod-paths="path/to/your/Class.class"
    3. --mod-paths="path/to/your/Class.class;path/to/your/Jar.jar" (Windows)
    4. --mod-paths="path/to/your/Class.class:path/to/your/Jar.jar" (Unix/Linux/MacOs)

--game-provider

  • default-value: None
  • required: False
  • description: When used, this forces puzzle-loader-core to run your supplied game provider if it applies the the application & implements the IGameProvider class.
  • example: --game-provider="com.example.provider.game.YourGameProvider"

Transformer arguments.

--do-title-transformer

  • default-value: true
  • required: False
  • description: Enables or Disables the usage of the custom-title-formatter.
  • examples:
    1. --do-title-transformer={true|false}
    2. --do-title-transformer=false

--custom-title-formatter

  • default-value: "Puzzle Loader %s"
  • required: False
  • description: Allows the setting of a custom title, either replacing the original or gets used as a format string.
  • examples:
    1. --custom-title-formatter="Using a format string -> %s <- that holds the title"
    2. --custom-title-formatter="%s Using a format string as a postfix"
    3. --custom-title-formatter="Using a format string as a prefix %s"
    4. --custom-title-formatter="Fully Custom Title"

--transformers-enabled

  • default-value: true
  • required: False
  • description: Enables or Disables the usage of transformers (including mixins).
  • examples:
    1. --transformers-enabled={true|false}
    2. --transformers-enabled=false

--user-transformers-enabled

  • default-value: true
  • required: False
  • description: Enables or Disables the usage of user made transformers, --transformers-enabled must be true.
  • examples:
    1. --user-transformers-enabled={true|false}
    2. --user-transformers-enabled=false

Mixin Arugments

--mixins-enabled

  • default-value: true
  • required: False
  • description: Enables or Disables the ability to Mix into classes using Mixins, --transformers-enabled must be true.
  • examples:
    1. --mixins-enabled={true|false}
    2. --mixins-enabled=false

Class-Loading Arugments

--allow-class-overrides

  • default-value: false
  • required: False
  • description: Enables/Disables the ability to pull classes from a local directory named "class-overrides".
  • examples:
    1. --allow-class-overrides={true|false}
    2. --allow-class-overrides=true

--dump-transformed-classes

  • default-value: false
  • required: False
  • description: Enables/Disables the dumping of classes that were transformed or mixed into by Mixins into a local directory named "class-transform-dump".
  • examples:
    1. --dump-transformed-classes={true|false}
    2. --dump-transformed-classes=true

--skip-boostrap-classloader

  • only for 0.1.8
  • default-value: true
  • required: False
  • description: Allows/Disallows the transforming of essential classes before the puzzle's runtime starts.
  • examples:
    1. --skip-boostrap-classloader={true|false}
    2. --skip-boostrap-classloader=false