WildStar:UI AddOn: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Created page with "{{wsaddon}} This is the WS AddOn development main reference. Use '''Reference''' for detailed information, '''Guides''' for getting started and further understanding, and...")
 
No edit summary
 
(21 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{uiaddon}}
{{dev/uiaddon}}
 
This is the development reference for the structure and rules for WildStar '''UI AddOns'''. See [[AddOn]] for the general WildStar term. See [[development]] for the main development portal.
This is the [[WS AddOn]] development main reference. Use '''Reference''' for detailed information, '''Guides''' for getting started and further understanding, and '''Summary''' for overall concepts details. See [[AddOns]] for information on the general ''AddOn'' term used in WildStar.


== Reference ==
== Reference ==
''WS AddOn files and related files and concepts''
''WS AddOn files and related files and concepts''


=== Code Files ===
=== Code files ===
* [[TOC file]] - WS AddOn special "manifest" 'XML' file.
* [[TOC file]] - WS AddOn special "manifest" 'toc.xml' file.
* [[XML file]] - WS AddOn 'XML' UI element 'form' file.
* [[XML file]] - WS AddOn 'XML' UI element 'form' file.
* [[LUA file]] - WS AddOn 'Lua' code file.
* [[LUA file]] - WS AddOn 'Lua' code file.


=== Details ===
=== Details ===
* [[AddOn_loading_process|Loading Process]] - WS AddOn loading process.
* [[AddOn loading process]] - WS AddOn loading process.


=== WS Files ===
=== Client files ===
* [[Machine.ini]]
* [[Machine.ini]]
* [[User.ini]]
* [[User.ini]]
Line 22: Line 21:
* [[Archive file]]
* [[Archive file]]
* [[Index 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 ==
== Help ==
Line 31: Line 36:


== Summary ==
== 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 [[AddOn]]s for WS. Before getting started, should read familiarize themselves with the [[WildStar AddOn Policy]]. For WildStar, most AddOn related files lie in your personal folders in the normally hidden AppData location.  
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 [[AddOn]]s for WS. Before getting started, should read familiarize themselves with the [[WildStar AddOn Policy]].


Example file layout anatomy of a basic [[WS AddOn]]:
Example file layout anatomy of a basic [[WS AddOn]]:
 
<div class="ws-compact">
* {WS Install} (folder) - your WS installation folder
* {WS Install} (folder) - your WS installation folder
** -- nothing --
** -- nothing --
* {Operating system drive} (drive) - your actual operating system 'system' hard drive
 
** Users (folder) - the standard Users folder in the root of the drive
* {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)
*** {User name} (folder)
**** AppData (folder)
**** AppData (folder)
***** Roaming (folder)
***** Roaming (folder)
****** NCSOFT (folder)
****** NCSOFT (folder)
******* WildStar(folder)
******* WildStar (folder)
******** AddOns (folder)
******** AddOns (folder)
********* MyAddOn (folder) - your AddOns own folder, normally matches the AddOn name
********* MyAddOn (folder) - your AddOn's own folder, normally matches the AddOn name
********** toc.xml ([[TOC file]]) - WS AddOn "manifest" file
********** toc.xml ([[TOC file]]) - WS AddOn "manifest" file
********** MyAddOn.xml ([[XML file]]) - [[XML]] file with visible element 'form' definitions
********** MyAddOn.xml ([[XML file]]) - [[XML]] file with visible element 'form' definitions
********** MyAddOn.lua ([[Lua file]]) - [[Code]] file, with instructions for AddOn behavior
********** MyAddOn.lua ([[Lua file]]) - [[Code]] file, with instructions for AddOn behavior
</div>




This example establishes a WS AddOn named 'MyAddOn' with one xml form file and one Lua code file.
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 ==
== External links ==
* [http://www.wildstar-online.com/en/news/wildstar_wednesday_yes_well_have_ui_addons.php/ wildstar-online.com] ''Yes, We'll Have UI Addons'' by [[Jon Wiesman]] client Lead Developer.
* [http://www.wildstar-online.com/en/news/wildstar_wednesday_yes_well_have_ui_addons.php/ wildstar-online.com] ''Yes, We'll Have UI Addons'' by [[\Jon Wiesman]] client Lead Developer.
* [http://massively.joystiq.com/2013/02/06/slap-a-rocket-on-a-pig-wildstars-modding-and-pgc-community/ joystiq.com] ''Slap a rocket on a pig'' by Brianna Royce (Feb-6-2013) - WildStar press event
* [http://massively.joystiq.com/2013/02/06/slap-a-rocket-on-a-pig-wildstars-modding-and-pgc-community/ joystiq.com] ''Slap a rocket on a pig'' by [[\Brianna Royce]] (Feb-6-2013) - WildStar press event
* [http://www.hiddenarena.com/content.php?160-Getting-Started-with-WildStar-Addon-Creation-Guide-Part-1 hiddenarena.com] ''Getting Started with WildStar Addon-Creation'' by Taterz (Dec-31-2013)
* [http://www.hiddenarena.com/content.php?160-Getting-Started-with-WildStar-Addon-Creation-Guide-Part-1 hiddenarena.com] ''Getting Started with WildStar Addon-Creation'' by Taterz (Dec-31-2013)
* [http://wildstarnasa.com/2014/01/a-complete-newbies-guide-to-apollo-and-houston/ wildstarnasa.com] - ''A Complete Newbie’s Guide to Apollo and Houston''
* [http://wildstarnasa.com/2014/01/a-complete-newbies-guide-to-apollo-and-houston/ wildstarnasa.com] - ''A Complete Newbie’s Guide to Apollo and Houston''

Latest revision as of 02:18, 13 August 2023

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

Reference[edit]

WS AddOn files and related files and concepts

Code files[edit]

  • 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[edit]

Client files[edit]

Art files[edit]

Help[edit]

Guides[edit]

FAQs[edit]

Icon-edit-22x22.png
Note: This is a generic section stub. You can help expand it by clicking Sprite-monaco-pencil.png Edit on the section title.

Summary[edit]

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 WS 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[edit]

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[edit]

Retrieved from "https://addonstudio.org/mw/index.php?title=WildStar:UI_AddOn&oldid=18397"