Installation - SFX-WoW/AceGUI-3.0_SFX-Widgets GitHub Wiki

Contents

Including the Library

External

The recommended way to include this library is to use an automated packager and set up an external in the add-on's .pkgmeta. This ensures that the latest version of the library is included when a new version of the add-on is released.

.pkgmeta
Libs/AceGUI-3.0_SFX-Widgets:
  url: https://github.com/SFX-WoW/AceGUI-3.0_SFX-Widgets.git
  tag: latest

Embedded

To embed the library directly into an add-on, download the latest release and include it with the package. Note that this will require manually updating the library whenever a new version is released. If you're using an automated packager, it's recommended to add the following to your .pkgmeta to let the packager know that the library is included.

.pkgmeta
embedded-libraries:
  - sfx-widgets

Referencing the Library

Reference the library by adding the appropriate line to the the add-on's <Addon>.toc or <Embeds>.xml file.

ToC
Libs\AceGUI-3.0_SFX-Widgets\AceGUI-3.0_SFX-Widgets.xml
XML
<Include file="Libs\AceGUI-3.0_SFX-Widgets\AceGUI-3.0_SFX-Widgets.xml"/>

It's also recommended to include an OptionalDeps line in your <Addon>.toc file in the event that the library is installed separately.

OptionalDeps
## OptionalDeps: Ace3, AceGUI-3.0_SFX-Widgets

Add-ons using this library should include it by default. In the event that the library is missing, install the package through your preferred add-on manager or use the manual instructions below.

Manual Installation

To install the library manually, follow the steps below. Note that this process will need to be repeated each time a new version is released.

  1. Download the latest release.
  2. Extract the package to the appropriate directory:
    • Retail: World of Warcraft\_retail_\Interface\AddOns
    • Classic Era: World of Warcraft\_classic_era_\Interface\AddOns
    • Wrath Classic: World of Warcraft\_classic_\Interface\AddOns
⚠️ **GitHub.com Fallback** ⚠️