Embedding

This page will walk you through the steps needed to embed LibRealmInfo in your addon, so other users of your addon don't need to install LibRealmInfo separately.

1. Add LibRealmInfo and its dependency LibStub to your addon's TOC file. LibStub needs to be loaded before LibRealmInfo, and both need to be loaded before your addon's files:

## Interface: 70000
## Title: Your Addon

Libs/LibStub/LibStub.lua
Libs/LibRealmInfo/LibRealmInfo.lua

YourAddon.lua

2. If you are using CurseForge or a compatible packager, add LibRealmInfo and LibStub to your addon's .pkgmeta file:

externals:
    Libs/LibRealmInfo:
        url: https://repos.curseforge.com/wow/librealminfo
        tag: latest
    Libs/LibStub:
        url: https://repos.wowace.com/wow/libstub/trunk
        tag: 1.0

3. If you are not using a packager, manually download LibRealmInfo and LibStub and place them inside your addon's folder in the expected locations.

4. As a developer, it is suggested that you install LibRealmInfo as a standalone addon. This will enable some debugging messages that may be useful, and will enable you to keep your local copy of the library up to date more easily.