BeardLib
  • Home
  • Things to Know
    • Adding Files
    • ScriptData
  • Modules
    • Achievements
    • Add Files
    • Adding your own modules
    • AssetUpdates (Mod Updates)
    • Classes
    • Contact (contractors)
    • Crime Spree Mission
    • DLC
    • Dependencies
    • Elements
    • Global Value (Tagging weapons/etc)
    • Heist Music
      • Stealth Music
    • Hooks
    • Interactions
    • Keybind
    • Level
    • Localization
    • Mask Material
    • Mask Pattern
    • Mask
    • Melee
    • Menu Music
    • Menu
    • ModuleBase
    • Narrative
    • Options
    • Package
    • Script Mods (Replace script data)
    • Sounds
    • Tweak Modify
    • Weapon Mod
    • Weapon Skin
    • Weapon
    • XML
  • API
    • BeardLib Class
    • Constants
    • File Manager
    • Frameworks
    • Hooks
    • ModCore
    • Package Manager
    • Special Hook IDs
  • Utilities
    • FileIO
    • Input
    • Main
    • Math
    • Menu Helper Plus
    • Path
    • String
    • Sync
    • Table
    • Tweak Data Helper
    • XML
    • YAML
  • MenuUI
    • ComboBox
    • ImageButton
    • Item
    • Items
    • Keybind
    • Menus
    • Slider
    • TextBox
    • Toggle
Powered by GitBook
On this page
  • Module Definition
  • Module name
  • XML Structure
  • Example

Was this helpful?

Edit on GitHub
  1. Modules

XML

PreviousWeaponNextAPI

Last updated 3 years ago

Was this helpful?

Updated for version 3.38.

Module Definition

The module is inherited from . So base parameters can be found there.

This module is great for organizing your mod into parts. If you always hated putting everything in the same XML but didn't want to use the file parameter this makes it easy to organize many modules into separated files.

Module name

The name of the module you use as the meta of the module definition is 'XML' or 'XMLModule' if _force_search is set to true in the module definition.

XML Structure

<XML path file_type>
    <load_first/>
</XML>

<XML path file_type>

Parameter
Type
Description

path

String

The path to the XML file that should be loaded

load_first

Table

An optional list of modules that should load first

file_type

String

The type of file that should load [Default: custom_xml] can be custom_xml, generic_xml an json.

Example

<XML path="Extra.xml"/>

This will load the file Extra.xml and read the modules that are inside of it.

This example is what you would put inside your main node within your

ModuleBase
mod config