BLT mod.txt Helper


This section contains the basic information for the mod. Base Definition Documentation
This will display in the Lua Mods section to give information and identify the mod.

The friendly name of your mod.
A description of your mod, and what it does.
You, your collaborators, or anybody who worked on the mod.
Some form of contact details for your users to contact you from. This might be a url or email address
A friendly version number that will displayed in the in-game mod manager.
An integer, from 0 to 1000, that determines the order in which mods load. This should only be used for mods which act as dependencies for other mods.
Example: Priority 100 is higher than 10

This section contains the Hooks you are creating. Hook Documentation
If you are converting a mod from PD2Hook.yml, these would be your "Post-Require" scripts.

Hook ID Hook Script
The Payday 2 script file to run your script after. Example lib/managers/hud/hudassaultcorner
The path to your Lua script to run. This is relative to your mod folder.
Examples:
  • WolfHud.lua would be a file named WolfHud.lua
  • lua/WolfHud.lua would be a file named WolfHud.lua in a folder called lua

This section contains the Pre-Hooks you are creating. Pre-Hook Documentation
If you are converting a mod from PD2Hook.yml, these would be your "Pre-Require" scripts.

Hook ID Hook Script
The Payday 2 script file to run your script before. Example lib/managers/hud/hudassaultcorner
The path to your Lua script to run. This is relative to your mod folder.
Examples:
  • WolfHud.lua would be a file named WolfHud.lua
  • lua/WolfHud.lua would be a file named WolfHud.lua in a folder called lua

This section contains the Persist Scripts you are creating. Persist Script Documentation
If you are converting a mod from PD2Hook.yml, these would be your "Persist-Scripts" scripts.

Global Hook Script
The global value to associate your script with. Example: WolfHud
This script will continuously run until the global variable is set to a value other than false or nil.
The path to your Lua script to run. This is relative to your mod folder.
Examples:
  • WolfHud.lua would be a file named WolfHud.lua
  • lua/WolfHud.lua would be a file named WolfHud.lua in a folder called lua

This section contains the keybinds you are creating. Keybind Documentation
If you are converting a mod from PD2Hook.yml, these would be your "Keybinds" scripts.

ID Name Description Keybind Script Run In Menu Run In Game Localized
A unique ID for your keybind. Your keybind will be saved and loaded via this ID, so make sure that it relates to your mod so that no other mods can override it.
The name of the keybind to display in the keybinds menu.
A short description of your keybind.
This would be the file to load when the keybind is pressed. The path is relative to the mod.txt file
Examples:
  • WolfHud.lua would be a file named WolfHud.lua
  • lua/WolfHud.lua would be a file named WolfHud.lua in a folder called lua
Whether this keybind should run when pressed during the menu state.
Whether this keybind should run when pressed during the game state.
Whether if the menu should attempt to use the name and description as localization keys. Leave unchecked you want to just type a name and description in or are unsure.
 Download mod.txt  Manually Copy mod.txt

Place the file named mod.txt into your mod folder
Example: mods/WolfHud/mod.txt
*Downloading mod.txt may not work in some browsers. If it does not work use the Manual Copy button


Created by: Jason Booth (Kilandor)
Thanks to:
  • Kail for lots testing and suggestions!
  • James Wilkinson, Sir Waddlesworth, and PaydayMods.com for BLT
Steam Discussion Thread