README.md

BGforge MLS IElib

Documentation | Forum

Infinity Engine library for BGforge MLS. It can be used standalone as well.

Essentially, it defines various constants: opcode numbers, icon numbers, etc, so that they could be used instead of magic numbers, improving overall code readability. (Similarly to what WeiDU does.)

Usage

1. Init submodule

   cd mymod
   git submodule add -b master https://github.com/BGforgeNet/BGforge-MLS-IElib.git lib/bgforge
   git commit -m "added BGforge IElib"

   (Note: once you've added a submodule to your repo, new clones will require an additional step: git submodule update --init --recursive.)
2. Enable

   ALWAYS
     OUTER_SPRINT BGFORGE_LIB_DIR "%MOD_FOLDER%/lib/bgforge"
     INCLUDE ~%BGFORGE_LIB_DIR%/main.tpa~
   END
   

3. Browse the code to see the available constants, use BGforge MLS to get tips (completion and stuff).

Update

git submodule update --remote
git add lib/bgforge
git commit -m "updated BGforge IElib"