AddOn Studio Wiki
Advertisement
Reference

UI AddOn
UI API
AddOn API
UI Form
UI XML
WS Lua
UI Macro
CVars
UI Event
Changes


Guides
Snippets


Categories

This is the development reference for the structure and rules for WildStar UI AddOns. See AddOns for the general WildStar term. See WildStar development for the main development portal.

Reference[]

WS AddOn files and related files and concepts

Code files[]

  • TOC file - WS AddOn special "manifest" 'toc.xml' file.
  • XML file - WS AddOn 'XML' UI element 'form' file.
  • LUA file - WS AddOn 'Lua' code file.

Details[]

Client files[]

  • Machine.ini
  • User.ini
  • Tools.ini
  • Account.ini
  • Character.ini
  • Archive file
  • Index file

Art files[]

  • TEX file - WS texture image file
  • TGA file - WS image file
  • M3 file - 3D model format
  • TTF file - True Type Font file

Help[]

  • WildStar AddOn Policy

Guides[]

  • Creating a WS AddOn

FAQs[]

Summary[]

WildStar is capable of loading special files for adding or modifying aspects of the game. WS uses these files to create User Interface functionality for its own interface. These files and facilities can also be used for creating custom user UI functionality, or AddOns for WS. Before getting started, should read familiarize themselves with the WildStar AddOn Policy.

Example file layout anatomy of a basic WildStar AddOn:

  • {WS Install} (folder) - your WS installation folder
    • -- nothing --
  • {Operating system drive} (drive) - your actual operating system 'system drive'
    • Users (folder) - standard Windows Users folder, in the root of the drive
      • {User name} (folder)
        • AppData (folder)
          • Roaming (folder)
            • NCSOFT (folder)
              • WildStar (folder)
                • AddOns (folder)
                  • MyAddOn (folder) - your AddOn's own folder, normally matches the AddOn name
                    • toc.xml (TOC file) - WS AddOn "manifest" file
                    • MyAddOn.xml (XML file) - XML file with visible element 'form' definitions
                    • MyAddOn.lua (Lua file) - Code file, with instructions for AddOn behavior

This example establishes a WS AddOn named 'MyAddOn' with one xml form file and one Lua code file.

AddOns folder[]

For WildStar, most AddOn related files lie in your personal folders in the normally hidden AppData location. The WildStar AddOns folder inside AppData contains folders for each user AddOn.

Using windows environment values:

 %appdata%\NCSOFT\WildStar\AddOns

Typical example

 c:\Users\[UserFolderName]\AppData\Roaming\NCSOFT\WildStar\AddOns

External links[]

Advertisement