Skip to content

Embedding

Adrian L Lange edited this page Feb 10, 2026 · 11 revisions

Here are some ways of including the library in your addon.

Automatic

Using an automated packager is the preferred method of embedding the library, as it takes out the overhead of maintaining the latest library version with the addon. By either using CurseForge's or BigWigs', you could use some simple metadata markup for retrieving dependencies.

Simply plop the this in to your .pkgmeta file and you're off to the races!

externals:
  libs/LibStub: # required dependency unless namespaced
    url: https://repos.curseforge.com/wow/libstub/trunk
    tag: 1.0
  libs/LibEditMode:
    url: https://github.com/p3lim-wow/LibEditMode
    tag: latest

See this article for more information.

Manual

Either by using gitmodules, subtrees or manually cloning or downloading the archive and extracting, the embedding can be handled manually if you prefer that.

TOC

In order for the library to load, it must be loaded from the addon.
Here's an example TOC file:

## Interface: 120000, 120001
## Title: MyAddOn

# include this if you want to use the namespaced mode
libs\LibEditMode\namespaced.lua
# OR
# use LibStub if you don't want to use the namespaced mode
libs\LibStub\LibStub.lua

# load LibEditMode
libs\LibEditMode\embed.xml

# ... the rest of your addon files

Clone this wiki locally