Go to Page... |
|
Thread Tools | Display Modes |
03-16-09, 11:38 AM | #1 |
Guide: Packaging up your UI to share with others.
Preface: I originally posted this guide back in January of 2007 on the old UI forums hosted by Incgamers under my old handle "Xinh". Sadly, that post is no longer searchable. That post was modified slightly and added to a stickied FAQ for those boards by Tunga, a then moderator, with more input from me. However I have noticed that these boards do not have a guide like the one I wrote for WoWUI except for some bits buried in various threads. Thus I have grabbed my old guide from the WoWUI forums and have transplanted here (with some updates and revisions).
Packing your UI to share with others So you have this great UI that you want to share with the rest of the WoW player community. Sounds tough, right?. This is easier than you might think. CAUTION This Guide was written with the current retail release (10.x, Dragonflight) in mind. If you are sharing a UI for World of Warcraft Classic or WotLK Classic, then you need to make the appropriate adjustments. It's nothing difficult. Replace "_retail_" with "_classic_" in your file paths. First, your AddOns:
Next, your UI settings Note: this section was written prior to 3.0 (WotLK) and the release of WoW Classic. For Windows Vista/7/8/10 users, there are some slight changes which have been incorporated into this guide. If you want to include your UI settings then you want to include your WTF folder in the zip file. Just make sure to change the ACCOUNT, SERVER and CHARACTER folder names to something generic (like "YOUR ACCOUNT", "YOUR SERVER", "YOUR CHARACTER") and remove all but one CHARACTER folder (unless you are including different settings for different classes, in that case name the folders accordingly such as DRUID, WARRIOR, TANK, HEALER, etc.). Again this is a good time to weed out any unused SavedVariables files as they will just clutter up your UI compilation and increase the size of the final file. Windows Vista/7/8/10 Users: For Windows Vista/7/8/10 users, if you installed WoW in the default location (C:\Program Files\) then your WTF folder will be located in Code:
C:\Users\<Username>\AppData\Local\VirtualStore\Program Files\World of Warcraft_retail_\Interface\WTF Note: The folder "AppData" is usually hidden by default so you will need to enable "View Hidden Items" from the View menu For OS X, your WTF folder is located in the same location as on a Windows XP install. Likewise for GNU/Linux. Code:
~/home/yourusername/Games/World of Warcraft/_retail_/Interface/WTF As per the updated WoWI rules (03 Apr 2009), you must change the names of these folders to a generic name (like Your Account, YOUR SERVER, YOUR CHARACTER). You cannot have personal information in the WTF folder. A quick interlude Why use the Interface (and WTF folder if included) folder as opposed to just the AddOns folder? Simple, it makes it real easy for your users to install as all they have to do is drop the unpacked Interface (and WTF folder if included) into their WoW directory. The Interface folder can contain more than just AddOns, things like custom Minimap button borders and other modified UI graphics/textures can be included here. If you do include the WTF folder, then your users also have to rename the files I listed. Fonts If your UI uses a custom Fonts folder to override WoW's fonts, then be sure to include it as well. However please check for any commercial fonts that may be in use, you should not include them as they could result in your UI being rejected. Try to use fonts that allow you to include them in your UI, include the font's license with your ReadMe. Most freeware font authors are pretty generous in regards to the usage of their fonts, however play it safe and check first. You don't want your UI to get taken down due to IP violations. If in doubt choose fonts which are open source either under the GPL/LGPL (or similar open source licence), Creative Commons or the SIL Open Font License. This also applies to fonts in SharedMedia or within individual AddOns. Package and upload Now that you have your Interface and WTF (and Fonts if you are including a Fonts folder) folders safely parked on your Desktop, it's time to prepare the actual file you will upload to WoWInterface.
Once your is zipped up, it's time to upload. Make sure you have a good screenshot (or more) of your UI to upload as you will need it (WoWI rules require at least one image). Both an out of combat and an in combat screenshot is a good idea. Also a screenshot of your AddOns folder showing all the AddOns in your UI is a good idea as it saves quite a bit of typing when you list the AddOns in your compilation. Before you upload, read the WoWI Upload Rules & Guidelines (I chose this particular post as it highlights a few areas of concern to a UI uploader). Your UI must conform to Blizzard's EULA, ToU and UI Add-On Development Policy. If your UI meets those guidelines, upload it. NOTE for first time UI compilers: If you are a first time uploader and your UI has serious issues, it may be simply deleted and you may not be contacted. If you do not see your UI on the site in a few days after you upload, double (or triple) check your UI for any of the issues I have listed. If you have questions, please PM an Admin or SMod. Take a bit of time when you type up your UI's description. Put yourself in a potential users's place. Sell your UI to him/her! However tell the truth! If your UI likes to eat CPU cycles for breakfast or will be difficult for novice users, then say so. Likewise if the UI is great for some classes/roles and terrible for others. Otherwise the truth will come out in the comments users will leave and they may not be gentle about it! Success! Once uploaded, it may take a couple of days before it shows up on the site. Have a bit of patience and let the Admins and SMods do their jobs as all uploads are human checked (as normal Homo sapiens using the ol' Mk. I Eyeball) for problem files and scanned for viruses. While you are waiting, you may want check for PMs as if the Admins/SMods discover an issue, this is the route you will likely be contacted by. Once your UI is approved, keep an eye on any comments that may appear. If users have problems, the comments section for your UI will be the first place that they will look (users will usually post question/comments first, look later). If you notice repeated questions about one thing, then that should be a clue to change a thing or two (either an AddOn, or maybe just some better documentation). Keep your UI up to date. When mods change, then your UI needs to change to accommodate the AddOns. When you do make changes to your UI, take advantage of the Change Log to document changes to your UI. You may wish to add this Change Log to your ReadMe as well. In addition, start a thread in the Released Compilations forums (http://www.wowinterface.com/forums/f...play.php?f=141) to provide a central point for folks who have support issues, suggestions, or just plain old thank yous.
__________________
Last edited by Zyonin : 03-28-23 at 01:51 PM. Reason: Slight update to reflect recent changes including the bump to Dragonflight (10.xx) and to add licencing info. |
|
WoWInterface » Developer Discussions » Tutorials & Other Helpful Info. » Guide: Packaging up your UI to share with others. |
«
Previous Thread
|
Next Thread
»
|
Display Modes |
Switch to Linear Mode |
Switch to Hybrid Mode |
Threaded Mode |
|
|