AddOn Studio for World of Warcraft documentation: Difference between revisions

no edit summary
No edit summary
 
(31 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{uiaddonstudio}}{{Tocright}}
{{uiaddonstudio}}{{Tocright}}
Learn how to use [[AddOn Studio for World of Warcraft]] to develop [[AddOns]] in [[Lua]] and [[XML]].
Learn how to set up and use [[AddOn Studio for World of Warcraft]] to develop [[wo:AddOns|AddOns]] in [[wo:Lua|Lua]] and [[wo:XML|XML]].


Documentation for AddOn Studio for WoW is added as time permits. Is intended to provide filler information for those who like to read more, or anyone who doesn't necessarily have a lot of experience with Visual Studio, or in some of these other areas.
== Resources ==
* Documentation - You are here...


== Other sources ==
* Main page - [[AddOn Studio]] (a good overview, with illustrations and FAQ)
* Home: [[AddOn Studio for WoW]]
 
* Change History: [[AddOn Studio for WoW History]]
* WoW home pages - [[AddOn Studio for WoW]]
* Edition Notes:
**[[AddOn Studio 2022 for WoW]]
**[[AddOn Studio 2022 for World of Warcraft]]
**[[AddOn Studio 2015 for WoW]]
**[[AddOn Studio 2019 for World of Warcraft]]
**[[AddOn Studio 2010 for WoW]]
**[[AddOn Studio 2017 for World of Warcraft]]
 
**[[AddOn Studio 2015 for World of Warcraft]]
* Quick Start: [[AddOn Studio 2022 for WoW#Getting Started]]
**[[AddOn Studio 2010 for World of Warcraft]]
* Latest Version: [[AddOn Studio 2022 for WoW#Release]]
* Issues: [http://fallenworlds.org/addonstudio/wow/support Issue Tracker and Forums]
 
* Discord: [//discord.gg/eAGb7Rc ASfW]
* Change History: [[AddOn Studio for WoW history]]
 
* Support: [http://addonstudio.org/wow/support Discord]
* Issues: [http://addonstudio.org/wow/issues Issue Tracker on GitHub]
 
* Discord: [//discord.gg/eAGb7Rc AddOn Studio]
* Twitter: [http://twitter.com/AddonStudioWoW @AddonStudioWoW]
* Twitter: [http://twitter.com/AddonStudioWoW @AddonStudioWoW]
* Tutorials: (in AddOn Studio) Help > Tutorials > AddOn Studio Tutorials
 
* Readme: (in AddOn Studio) Help > Additional Docs > Readme
* Tutorials: ''(in AddOn Studio)'' Help > Tutorials > AddOn Studio Tutorials
* WoW Reference: [[Portal:Interface customization|WoW customization portal and API reference]]
* Readme: ''(in AddOn Studio)'' Help > Additional Docs > Readme
 
* WoW AddOn Reference: [[wo:development|WoW customization portal and API reference]]
 
== Documentation pages ==
 
* [[AddOn Studio 2022 for WoW#Getting Started|Getting Started]] - the regular, very short section on the main edition page.
* [[AddOn Studio for World of Warcraft documentation|AddOn Studio for WoW documentation]] - You are here... see below [[#Preface]]
** [[AddOn Studio for World of Warcraft documentation/Windows explorer and install files|Windows Explorer and Install Files]] - Right-click menus, install files, and commands
* more pages soon....
 
== Preface ==
The original one-page AddOn Studio documentation.
 
This page is intended to provide filler information for the regular, very short [[AddOn Studio 2022 for WoW#Getting Started|Getting Started]] section on the main edition page. This is for anyone who might not necessarily have a lot of experience with Visual Studio, using folders in Windows, or in some of the other related areas. Documentation is added as time permits.


== About AddOn Studio ==
== About AddOn Studio ==
''An introduction to the AddOn Studio IDE and AddOn development''
''An introduction to the AddOn Studio IDE and AddOn development''


With AddOn Studio for World of Warcraft, it be deceptively easy to get started and see your first AddOn running in WoW within in minutes, even with no real experience. However the complexities inherent in game development when combined with a modern fully-featured IDE like AddOn Studio, can be complex and can often seem overwhelming.
With AddOn Studio for World of Warcraft, it be deceptively easy to get started and see your first AddOn running in WoW within in minutes, even with no real experience. However, the complexities inherent in game development when combined with a modern fully featured IDE like AddOn Studio, can be complex and can often seem overwhelming.


An "IDE" is an Integrated Development Environment, where lots of tools and facilities are clustered together in one application in an attempt to make things more convenient, to save time, and help you focus more on what you are really trying to do, so the theory goes...  Many times however this doesn't actually happen. The complexities of mastering the development environment can be a daunting task in itself, in addition to everything else.
An "IDE" is an Integrated Development Environment, where lots of tools and facilities are clustered together in one application in an attempt to make things more convenient, to save time, and help you focus more on what you are really trying to do, so the theory goes...  Many times, however, this doesn't actually happen. Just mastering the development environment, itself, can be a daunting task in addition to everything else.


With all this in mind, I'm going to do my rendition of "breaking things down" for how to get started with WoW AddOn development and AddOn Studio, especially for those who aren't already "hobbyists" or professional programmers and might be just starting out, or were just curious.
With all this in mind, I'm going to do my rendition of "breaking things down" for how to get started with WoW AddOn development and AddOn Studio, especially for those who aren't already "hobbyists" or professional programmers and might be just starting out or were just curious.


== AddOn Studio Basics ==
== AddOn Studio basics ==
''A more detailed Quick Start''
''A more detailed Quick Start''


Instructions on [[AddOn Studio 2010 for WoW]] or [[AddOn Studio 2015 for WoW]] pages cover all the essential steps. It's essentially copying the folder in the zip, and then running the executable. From there you can create a new WoW AddOn project, click 'build' to deploy to WoW, and then '/reload' in WoW to see it.  
Instructions on the edition pages, [[AddOn Studio 2010 for WoW]], [[AddOn Studio 2015 for WoW]] or [[AddOn Studio 2022 for WoW]], cover all the essential steps. It's basically just copying the folder in the zip, and then running the executable. From there you can create a new WoW AddOn project, click 'build' to deploy to WoW, and then '/reload' in WoW to see it.  


=== Installation ===
=== Installation ===
# Install Visual Studio or Isolated Shell using the links provided. Just click and run, and follow the instructions. Should go smoothly.
# Install Visual Studio or Isolated Shell using the links provided. Just click and run and follow the instructions. Should go smoothly.
# Click the AddOn Studio download link provided.
# Click the AddOn Studio download link provided.
# Click "open" from the browser, to open the zip or 7z file.
# Click "open" from the browser or download folder, to open the zip or 7z file.
# In the open zip file, move the 'AddOn Studio for WoW' folder to your desktop, or another folder.
# In the open zip file, move the 'AddOn Studio for WoW' folder to your desktop, or another folder.
# In the 'AddOn Studio for WoW' folder, run the 'WowAddonStudio.exe' application.
# In the 'AddOn Studio for WoW' folder, run the 'WowAddonStudio.exe' application.
# Right-click the running application in the task bar, and click "Pin to task bar" to make a shortcut.
# Right-click the running application in the task bar, then click "Pin to task bar" to make a shortcut.


=== Basic usage ===
=== Basic usage ===
Line 69: Line 89:
# Uninstall or keep the Visual Studio install
# Uninstall or keep the Visual Studio install


== Getting AddOn Studio Running ==
== Getting AddOn Studio running ==
''Even more detailed Installation and running of AddOn Studio for the first time.''
''Even more detailed Installation and running of AddOn Studio for the first time.''


Line 97: Line 117:
However, if for some reason you see a sea of files all named WowAddonStudio with no extension except one ".exe", then is because you have your Windows Explorer set to not show extensions, which is fine, and is how Windows usually comes by default.  In fact, one of the files is actually named "WowAddonStudio.exe.config" and with extensions hidden will look like the right file, but its not. To see extensions, "hide extensions for known file types" can be disabled.
However, if for some reason you see a sea of files all named WowAddonStudio with no extension except one ".exe", then is because you have your Windows Explorer set to not show extensions, which is fine, and is how Windows usually comes by default.  In fact, one of the files is actually named "WowAddonStudio.exe.config" and with extensions hidden will look like the right file, but its not. To see extensions, "hide extensions for known file types" can be disabled.


Another way is to click on each file and look at the status bar at the bottom or look top the right if you have detail view selected which will reveal the file type. To disable "hide extensions for known file types: from the Windows Explorer window you are already in, press "Alt" > Click "Tools" in the top menu > Click "Folder Options..." > Click the "View" tab > Find "Hide extensions for known types" about half way down the list > Uncheck that option > Click "OK".
Another way is to click on each file and look at the status bar at the bottom or look top the right if you have detail view selected which will reveal the file type. To disable "hide extensions for known file types: from the Windows Explorer window you are already in, press "Alt" > Click "Tools" in the top menu > Click "Folder Options..." > Click the "View" tab > Find "Hide extensions for known types" about half-way down the list > Uncheck that option > Click "OK".


=== 4. Make a Shortcut ===
=== 4. Make a shortcut ===
Now that you have found the exe file, you can make an shortcut. There are tons of ways to do this.
Now that you have found the exe file, you can make an shortcut. There are tons of ways to do this.


For Windows 10, 8.1 and 8, probably the easiest thing to do is to just right-click on the running application in the Windows task bar, and click "Pin to task bar". And additionally if desired, after right-clicking the first time, right-click again on the "AddOn Studio for ..." line and click "Pin to Start". At that point you should have a pinned shortcut icon on the windows task bar, and/or one in the start menu, and you are done.
For Windows 10, 8.1 and 8, probably the easiest thing to do is to just right-click on the running application in the Windows task bar, and click "Pin to task bar". And if desired, after right-clicking the first time, right-click again on the "AddOn Studio for ..." line and click "Pin to Start". At that point you should have a pinned shortcut icon on the windows task bar, and/or one in the start menu, and you are done.


For Windows 7 and Windows Vista (or Windows 10, 8.1, or 8 as an alternate way) just right-click on the application file, the real ".exe" file, and then click either "Pin to task bar" or "Pin to startup menu". At that point you should see a pinned shortcut icon on either and you are done.
For Windows 7 and Windows Vista (or Windows 10, 8.1, or 8 as an alternate way) just right-click on the application file, the real ".exe" file, and then click either "Pin to task bar" or "Pin to startup menu". At that point you should see a pinned shortcut icon on either and you are done.
Line 108: Line 128:
On XP (or Windows Vista or Windows 7 as an alternate way) you can, using the *right* mouse button, drag the file to the taskbar "quick launch" menu, or the start menu, or the desktop. And when you release the mouse button, select "create shortcut". And you are done :)
On XP (or Windows Vista or Windows 7 as an alternate way) you can, using the *right* mouse button, drag the file to the taskbar "quick launch" menu, or the start menu, or the desktop. And when you release the mouse button, select "create shortcut". And you are done :)


== Getting Started ==
== Getting started ==
''Hints and help for Getting Started in AddOn Studio''
''Hints and help for Getting Started in AddOn Studio''


Line 118: Line 138:
:''(More to be added here later...)''
:''(More to be added here later...)''


:''This may also be a good time to check out the Tutorials in AddOn Studio, in the mean time. They are a bit dated, but go over the most important aspects of getting around AddOn Studio while doing development. The 'in-program' tutorials contain lots of screen shots and illustrations as well.''
:''This may also be a good time to check out the Tutorials in AddOn Studio, in the meantime. They are a bit dated, but go over the most important aspects of getting around AddOn Studio while doing development. The 'in-program' tutorials contain lots of screen shots and illustrations as well.''


:''In AddOn Studio: navigate Help > Tutorials > AddOn Studio Tutorials''
:''In AddOn Studio: navigate Help > Tutorials > AddOn Studio Tutorials''
Line 131: Line 151:


== WoW customization reference ==
== WoW customization reference ==
* [[WoW AddOn|WoW AddOns]]
* [[wo:AddOn|WoW AddOns]]
* [[XML UI|WoW XML]]
* [[wo:XML UI|WoW XML]]
* [[Widget API|WoW Widget API]]
* [[wo:Widget API|WoW Widget API]]
* [[World of Warcraft API|WoW API]]
* [[wo:World of Warcraft API|WoW API]]
* [[Lua functions|WoW Lua]]
* [[wo:Lua functions|WoW Lua]]


== Advanced Instructions and Help ==
== Advanced instructions and help ==
''Further advanced help and options.''
''Further advanced help and options.''


Line 160: Line 180:
# The only relevant portion of the install theoretically for AddOn dev is in the 'Data' folder. Inside that folder are folders that look like 'enTW' and 'zhTW'. Those are the language specific portions of WoW and are also the UI specific portions in total. The WoW UI content is always language specific, even if there are redundancies between them. In this case 'enTW' is English localized for Taiwan, and 'zhTW' is technically Chinese localized for Taiwan even though its really kind of its own language, and just to give you some context and perspective. The 'WTF' folder in the base WoW install folder can also be significant if you are trying to ensure or test variables. AddOn Studio will use the currently set WoW language by default, which is stored in the WTF folder in Config.wtf. Which language AddOn Studio uses can also be changed in the AddOn Studio settings.
# The only relevant portion of the install theoretically for AddOn dev is in the 'Data' folder. Inside that folder are folders that look like 'enTW' and 'zhTW'. Those are the language specific portions of WoW and are also the UI specific portions in total. The WoW UI content is always language specific, even if there are redundancies between them. In this case 'enTW' is English localized for Taiwan, and 'zhTW' is technically Chinese localized for Taiwan even though its really kind of its own language, and just to give you some context and perspective. The 'WTF' folder in the base WoW install folder can also be significant if you are trying to ensure or test variables. AddOn Studio will use the currently set WoW language by default, which is stored in the WTF folder in Config.wtf. Which language AddOn Studio uses can also be changed in the AddOn Studio settings.


== Tutorial of the Day ==
== Tutorials ==
* [http://habrahabr.ru/blogs/gdev/119312/ 06/01/2011 - Old Russian Tutorial] - but one of the best I've seen outside of WoWWiki ([http://translate.google.com/translate?js=n&prev=_t&hl=en&ie=UTF-8&layout=2&eotf=1&sl=auto&tl=en&u=http%3A%2F%2Fhabrahabr.ru%2Fblogs%2Fgdev%2F119312%2F English Translation])<br/>Got to love the brutal honesty in the commentary, and in the ensuing discussion about WoW in general. God save our English language. :)
* [http://habrahabr.ru/blogs/gdev/119312/ 06/01/2011 - Old Russian Tutorial] - but one of the best I've seen outside of WoWWiki ([http://translate.google.com/translate?js=n&prev=_t&hl=en&ie=UTF-8&layout=2&eotf=1&sl=auto&tl=en&u=http%3A%2F%2Fhabrahabr.ru%2Fblogs%2Fgdev%2F119312%2F English Translation])<br/>Got to love the brutal honesty in the commentary, and in the ensuing discussion about WoW in general. God save our English language. :)


* [http://wowinanhour.gameldar.com/2010/03/wow-in-hour-write-addon.html 08/05/2011 - AddOn in an Hour tutorial] - A nice, relaxed, "finding your nose" starter tutorial, written as much more of a "how to not hang yourself getting started" blog. Recommended...
* [http://wowinanhour.gameldar.com/2010/03/wow-in-hour-write-addon.html 08/05/2011 - AddOn in an Hour tutorial] - A nice, relaxed, "finding your nose" starter tutorial, written as much more of a "how to not hang yourself getting started" blog. Recommended...


== See also ==
== See also ==
Line 170: Line 190:
* [[AddOn Studio 2022 for WoW]]
* [[AddOn Studio 2022 for WoW]]
* [[AddOn Studio for WoW]]
* [[AddOn Studio for WoW]]
* [[AddOn Studio for WoW History]]
* [[AddOn Studio for WoW history]]
 
== External links ==
[http://habrahabr.ru/blogs/gdev/119312/ Old Russian Tutorial]