Basic Guide Window
How To Install:
Windows XP location:
C:\Program Files\World of Warcraft\Interface\Addons
Windows Vista/7 location:
C:\Users\Public\Games\World of Warcraft\Interface\Addons
Macintosh Main HD/Applications/World of Warcraft/Interface/Addons
You can also visit the WoW-Pro Leveling Addon Troubleshooting Guide, where you'll find a fix for most common issues.
The Addon Dev Team
This guide will hopefully solve any problems you are having with the addon.
For instructions on how to download/install our addon see the How to Install section on this page.
Be sure you always completely close WoW and restart it after modifying your addons and before going any further. If all else fails, try a full computer restart, it can actually clear up a lot of issues.
*Note, our site only provides support for live realms. If you are playing on a private server, our addon may not work for you.
BEFORE YOU READ FARTHER: Is your version of our addon up to date? Is your version of TomTom up to date? If you answered no, please go update them as a first troubleshooting measure!
Problem: I don't have an arrow to guide me.
Problem: When I log in, My addon says "No guide loaded". What should I do?
Problem: I have no guides in the guide list. Or, the addon isn't showing up at all.
Windows XP location:
C:\Program Files\World of Warcraft\Interface\Addons
Windows Vista/7 location:
C:\Users\Public\Games\World of Warcraft\Interface\Addons
Macintosh Main HD/Applications/World of Warcraft/Interface/Addons
This picture is for a default windows 7 install, but should help you understand what we mean by seeing TWO folders, not one:
Make sure you also close wow 100% before trying to see your changes.
If, after trying all of this, you are STILL unable to see the addon in your in-game checklist, AND if you use the curse auto-updater, please try the following:
Thanks to Screamindaemon for this workaround!
Problem: Wait! I'm only missing XXXXXX guide! What now?
Open the WoWPro_Leveling folder, then open the Horde folder. Open "80_82_Arixan_Vashjir.lua" with a text editor (like Notepad). Go all the way to the last line.
The last thing you should see is...
Reset your profile. Right click on the panda or open your Interface menu, Addons tab. Under WoW-Pro Guides, click WoW-Pro Profiles, then Reset Profile.
Right click on the step. If you still have trouble, see the next solution.
Shift click on the guide in the guide list.
If none of the above solutions work for you, feel free to contact us in the Addon Questions Chat.
If possible please copy any lua errors you are receiving or take a screenshot of your issue. Thanks!
This is the Part 1 of the guide on how to use git / github, covering Introduction and Installations.
Table of Contents
WoWPro addons are developed using a control version system called git and hosted in github, a git public hosting site (I’ll explain what that means later on). Although you are definitely not required to learn git in order to contribute with WoWPro addons, it certainly wouldn’t hurt.
It is mainly designed to be useful to WoWPro addon developers, allowing them an easier and more resourceful access to the project. For people out there with some programming skills, who want to contribute with the development of the addon, then this guide is definitely for you! Along with the tutorials themselves, I'll also show some "etiquette" suggestions when using git / github.
For guide writers/coders/editors, this guide can certainly be also useful. However, just be aware that we are trying to centralize guide edits, posts and bugs on their respective community pages here on WoWPro.com. So, we ask you to not push your changes directly into the original github's project. But even with this restriction, using git can help tremendously in your task! I'll explain all that in the next part of the guide, as well as some "etiquette" suggestions.
For people who are reading this guide right now and have no idea what this is all about (like general WoWPro addon users), but are curious and willing to learn new things, then I invite you to also read the guide. But I won’t mind if you go somewhere else.
Also, this guide assumes Windows users, but if you have another operating system, you should be able to follow it just fine, as the git user interfaces should be similar across OSs.
There is a plethora of guides, tutorials, articles on how git will save the world, articles on how git sucks, etc on the Internet and it is not my intention to compete with them (in fact, I’ll provide several references at a later time). Partly because it wouldn’t be useful to the community here and partly because I’m not an expert on this subject! So, this guide is really just an overview of git and github, with some tutorials focused on WoWPro addon.
2. What’s git?
Let’s say you have a project composed of text files, that you continuously perform changes. Since the changes can be somewhat sensitive, you then decide to keep track of different versions of the same files, over time. The classical way is opening up the relevant, original file in a text editor, make the changes you want, and then use the “Save as...” option. Then, the name of the new file can be the original’s, plus some other identification, like a version number or the date it was created/modified.
But as the number of versions increases, it gets difficult to know what each of them actually means with just different name files. So, you could also improve this pedantic version control by writing, at the beginning of the text file, a change log, enumerating all the changes you performed in that particular version.
It works, but as you can see (for a number of reasons), this cumbersome system does not scale well with the number of files/lines, number of versions, etc. So people developed other, smart control version systems, of which git is one of them. These can perform easily all the processes described above and more! You’ll see some of the functionalities later on.
Before we get to the tutorials, there’s something else I should mention: what happens if you have more than one person working on the same project? This leads us to github...
3. What’s github?
You can do all the control version processes described above with git, in your local computer. You don’t really need to be like me, who does not remember even what he had for dinner last night, to appreciate easy access to changes / versions / comparisons in a personal project you’ve been working on, say, for months.
But a control version system really shines when more than one person is working on the same project, especially nowadays with all the open source projects and global collaboration. For that, a git project can be hosted in a server, which can then be accessed (and potentially modified), by people around the world through the internet.
Github is git hosting site, which provides interesting functionalities to project management and collaboration. You’ll learn some of them in the next tutorials.
Nomenclature: Repository (repo, for short): a git project, its files and information stored by git, such as the different project versions. A repository can also refer to a full copy of a git project (more on that later). If it’s located in your local computer, then it’s called “local repository”. If it’s shared, in a server, it’s called remote repository. Usually, you need a local repo in order to work with a remote one.
Now let's get on the hands-on...
4. Tutorial: Getting started
Let’s start by downloading and installing git. There are several tools and interfaces that you can use to do git control version, from the blander, but more robust command lines to graphical interfaces. For this guide, we’ll use a git interface for Windows, called Git Extensions. For a complete list of interfaces, including the original one for unix/linux, check the following reference link: Git Interfaces list.
You can download the latest version of Git Extensions from here:
Or more directly, for the version as of this writing, here:
Run the downloaded file to begin the installation:
Unless you have absolutely sure you have the required softwares, check to install both of them and continue in Next:
For the next step, leave the installed features as they are, just click Next. But here, let's use Putty:
Then, just continue with the installation. At some point, it will ask you to install Git (which is actually the core’s program) and kdiff3, which you shouldn’t worry about it. For both, just use the default options as they are and keep clicking “Next” or “Continue”.
If the installation is successful, you should see a new icon on your Windows desktop (and/or somewhere in the Windows Programs menus), that looks like... hmm... a Tauren?. Open the program Git Extensions, click “Ok” if a checklist settings window is shown, and you should finally see something like this:
For this guide, as you can see, we’ll use the graphical interface, but don’t be afraid to use the git command line if you want to. Git commands are few and easy to remember (yes, even to me), since they are all English words. If you want to try that later, you should see a program called git bash, which opens the git command line.
Ok, now let Git Extensions rest for now and let’s deal with github...
Go on github.com and click on the big, blue button. Don’t be scared about the plans, prices... for public projects such as the WoWPro addon, github is completely free, easy and quick to sign up and use.
Now, choose the Create a Free Account option. Unless you already have a github account, just choose an username, e-mail, password and you’re good to go. Your github home looks a little empty right now... but we'll fix that in the Part 2 of the guide!
This is the Part 2 of the guide on how to use git / github, covering Forking github projects and managing local and remote repositories.
Table of Contents
1. Tutorial: Forking & Remote repository
So, by now, you should have your very own github account.
Let's add a project to it, by "forking" WoWPro’s addon, from Jiyambi’s original repository.
Nomenclature: Fork: make a full copy of a github project in order to start independent development on it.
For that, while logged into Github, go to Jiyambi’s repo, here: http://github.com/Jiyambi/WoW-Pro-Guides
And click the "Fork" button. You can also click Watch, to receive notifications and news, by e-mail and on your github homepage, related to the project.
Ok, now you have a forked version of WoWPro's addon. Don’t worry about all the news things that came up on that page, we’ll be dealing with some of them as the guide progress.
As you can see, your forked project is called username/WoW-Pro-Guides, which will be your personal remote repository of WoWPro.
But now, to actually modify it, as I hinted before, we need to have a local repository of that remote. For that, we go back to gitExtensions. (From now on, try to keep both gitExtensions and the github site opened and/or minimed for quick access).
2. Tutorial: Setting up keys?
Before we go on with the tutorial, let me explain a bit the next steps. The communication between your local and remote repo(s) is done via the SSH protocol, by using a pair of keys that can recognize each other. One of the keys, called private, will be stored on your local computer (and attached to you local repo) and the other key, public, will be given to github (the remote).
But how do we create a pair of keys in the first place? Fortunately, GitExtensions has a tool to generate pretty unique keys. Click on Remotes->PuTTY->Generate or import key.
Click on Generate and you get a short and easy mini-game: just keep moving your mouse cursor around until you complete the green bar and the keys get generated.
For the private key, you'll just need to save it in your computer by clicking 'save private key button'. We'll use it in a minute, so save it with a file name and in a location you'll remember (unless you want to it to play the mouse cursor mini-game again!)
You should also see a field, highligthed above, with random characters on the top of that window: that's the public key. It starts with 'ssh-rsa' and ends with '==somename'. We are going to copy that public key (exactly as it is) and paste it in the following place, on github: Account Settings -> SSH Public Keys -> Add Another Public Key:
Before minimizing/moving on, let's copy the repo remote address. Go to your forked project home, and copy the address highlighted below ( should be like :username\WoW-Pro-Guides.git ).
3. Tutorial: Creating a local repository
Now let's finally download the repo. Go back to GitExtensions, click on 'Clone repository'. Paste the just copied address into the field: 'repository to clone', choose a place for it in 'destination'. In the field 'branch', just pick 'master'. It should look like the following:
Now click on Load SSH Key to load the generated private key we saved earlier. Then, click on Clone. If all is well, you should see the download of the repo and, at the end, the notice that the cloning was successful. If not, go back to the 'generate keys' section. If you're still getting errors, post a comment on this thread.
Important notices for WoWPro project
Before moving on with the guide (in part 3), which will deal with the actual editing of file codes, I'd like to draw attention to two things regarding how WoWPro addon project is organized:
Part 3 should be up soon, where by soon (tm) I mean when it's ready!
In this guide, I'll go over how to use the WoW-Pro Recorder to help you write leveling guides. The Recorder is awesome both for writing addon guides, AND for writing paper guides - the pseudo-code is very simple and works GREAT for an outline for your paper guide, and has all the information you'll need including coordinates, quest IDs, and NPC names!
Coming Soon: The Recorder will soon have the ability to add notes to quests, add custom steps, and delete steps on the fly, but right now all it can do is record automated steps. I'll post comments on this guide, as well as update the guide, when the new features are added to the recorder.
Unzip the file into your beta addons folder. You should have three separate folders:
Everything should be ready to go - fire up the beta and log in!
If you'd like to append a guide that's already been created, skip to the Editing an Existing Guide section below.
To create a new guide, simply click on the "new" button. It's toward the right side of the Recorder's bar, and it looks like a piece of blank paper.
This will bring up a dialog box asking what type of guide you'd like to create. For now, we only have one type, and that's Leveling! Select it.
This will being up a new window. Now, some of these fields will be automatically filled out. I need to make this very very clear:
YOU HAVE TO HIT "ENTER" FOR EVERY SINGLE FIELD EVEN IF IT'S ALREADY FILLED OUT!
I plan to fix this in the future but for now please just hit enter in each field. Sorries!
Note that the stuff you put in these fields isn't really that important, and can always be edited later.
Once all of the fields are filled out, just hit "Register Guide". If you did it correctly, your guide window will change to a mostly blank guide with one step, called "First Step". If it doesn't change, it means you didn't hit enter for every field - try going through them all again.
Now that you have a new guide, you can start recording! Skip to the Recording section below.
If you want to add to one of the guides that's already included in the addon, OR if you have saved a guide using the recorder and would like to edit it, this section will explain how to do that.
All you need to do is open up the guide you want from the guide list, just as you would if you wanted to play it! Don't worry if it's already completed - if the recorder is enabled, the addon doesn't automatically ask if you want to go to the next guide.
Note: Guides saved with the recorder currently aren't displayed on the guide list. Instead, you can access them by clicking the "Open Guide" button (it looks like a folder). This will open a dialog where you can select the guide you want to edit. This list will contain ALL guides, both those in the WoWPro_Leveling folder, and those you've saved using the Recorder.
First of all - the recorder is set to "REC" or record, by default. You can use the record (circle) and stop (square) buttons to toggle between recording and not recording. This can be useful in several situations. Say for example you take a break to do an instance - you can stop recording during the instance so instance quests aren't tracked. Similarly, if you for example need to abandon and re-accept a quest, you can stop the recorder so the second accept step isn't tracked.
Once you have the guide you want loaded and the recorder is set to "REC", you really don't have to do anything - just play the game! It can be useful, however, to keep in mind the things that the guide recorder records.
If you make a mistake while recording, you can delete the last step recorded by using the minus (-) button.
I recommend recording while in scroll mode. This will allow you to see what you are recording. You'll note that the bottom step will be highlighted - this is the active recorder step. New steps will be placed AFTER this step. This is also the step that will be edited when using the edit or delete buttons.
To change steps, simply left-click on a different step! You can also right-click a step to open a small menu. With this menu, you can move the step up, down, or clone it.
You can add new steps by clicking the "Add Step" button - it looks like a plus (+) sign. You can choose to have the recorder automatically fill in information from one of your quests, or you can fill everything in for a step from scratch.
You can also edit the selected step by clicking the "Edit Step" button - it looks like a pencil.
Now that you know how to record, you need to know what to do with the data you are gathering.
Though the recorder does save your work automatically when a new step is added, it's still wise to save it manually, and often! That's because when WoW closes unexpectedly, it doesn't always save it's saved variables, and your data may be lost!
You can save your work at any time by clicking on the save button. It's on the far right of the Recorder's bar, and it looks like a little disk.
Clicking this button does two things.
FIRST: It will save your data in the WTF file. When you quit and log back in, your guide will be loaded and you can select it at the bottom of the guide list. Note that the guide is also automatically saved every time a new step is added.
SECOND: It will open a dialog box which contains the code for your guide. This is how you will submit your guide, and also the best way to manually save to make sure you don't lose your work - just copy/paste the stuff in the box into a text file and save it. You can also use this to work with your guide to fill it out, change the order, and more - we'll cover that later in the Working With the File section. For now, just know that you can safely close this box without doing anything to it if you want to.
Just hit that save button often and you'll be okay, I'll try to get an auto-save feature enabled soon!
Note that with the advanced features recently added to the recorder, it's no longer necessary to work directly with the file. Reading this section still may give you some insight into how the files work, though, which can be useful.
If you would like to do a bit more advanced work with the guide file, please read this section. No coding knowledge of any sort is needed - the guide files are written in pseudo-code and they are very easy to understand once you have a key.
First of all, open up your favorite simple text editor. I prefer Notepad++, it's a WONDERFUL editor with lots of very nice features.
Open up a new text file. Now, hit the save button on the recorder to bring up the code for your guide. Select all (Ctrl+A for PC users) and copy (Ctrl+C for PC users). Paste your code into your new file.
You should see something that looks similar to this:
A Clear the High Road|QID|24504|M|31.42,13.32|N|From Nura Pathfinder.| f Hunter's Hill|QID|24504|M|39.75,20.18|N|At Unega.| h Hunter's Hill|QID|24504|M|39.30,20.05|N|At Innkeeper Hurnahet.| C Clear the High Road|QID|24504|M|35.93,15.58| L Level 30|QID|24504|N|You should be around level 30 by this point| T Clear the High Road|QID|24504|M|37.36,16.70|N|To Tunawa Stillwind.|
First, I'll explain how to read this stuff and what it means. Then, I'll tell you how you can improve your guide file's code to make it even better!
Anatomy of a guide step:
Each step is only ONE LINE of code. A new line means a new step to the addon.
|M|37.36,16.70| = Tells TomTom where to map it's arrow to.
|N|To Tunawa Stillwind.| = Displays "To Tunawa Stillwind" as a note for this step. These should be limited to one or two sentences - we want to minimize reading as much as possible!
This covers the basics of the pseudo-code. It would be really awesome if people wanted to improve their guide file code before submitting it, since it's pretty bare-bones otherwise. However, some guide code is MUCH better than no guide code, so if you don't feel comfortable doing this, don't worry about it!
If you'd like to learn more about the pseudo-code and how to use it, check out the addon's documentation page!
So now you've got some stuff recorded - maybe you even edited the code to make it a bit nicer. What do you do with it?
Well, lucky you, it's really easy to submit your code to the addon! All you have to do is make a comment on this page containing your copy/pasted code! Be sure to disable rich text and set the input format to bbcode so the line break don't get wrapped. I'll look it over, and if it seems sound, I'll put it into the addon!
Remember that not only are we trying to get a lot of addon guides done, we also want to make more "paper" guides - guides here on our website. If you'd like to make a paper guide based on your (or someone else's) recorded guide, go ahead! You already have most of the information you need for your guide at your fingertips - all you need are maps and screenshots. The recorder file makes a very nice outline, as well, with steps that can be easily moved around to make the best questing route.
Register Guide doesn't seem to do anything - I don't see my guide being recorded! Is the addon broken?
My guide won't save, what's going on? I'm getting lua errors when I try to save!
I was testing a guide, and when I got to the end, it started repeating! What happened?
Please let me know if you have any questions about this process, either by PM or by comment!
I am working on a new module for the WoW-Pro addon called WoW-Pro Dungeons, that should provide the framework for guides and information related to dungeons in World of Warcraft. Right now, the WoW-Pro Dungeons is still in its early alpha stage, but I decided to create this page to explain my own design ideas and to hear feedback from the community (especially those that are in the beta, since I'm not).
That way, if we decide to change something, I won't waste too much programming time.
WoW-Pro Dungeons will make use of the WoW-Pro Guide frame, showing steps and information in a similar way, that happens now, with the WoW-Pro Leveling module. Because of this, only one module will be active at a given time, but there should be plenty of options for the player to switch between them, manually or automatically (more on that later).
But there are important differences between leveling and dungeon guides:
Therefore, unlike WoW-Pro Leveling, WoW-Pro Dungeons should allow access to different types of guides, for each dungeon, from the more basic to the more lenghty. For another hand, the dungeon guides should follow, as much as possible, the format of the WoW-Pro Leveling guides, to not confuse guide writers and players.
Types of Dungeon Guides
The types of guides, for each dungeon, I'm thinking of are the following:
EDIT: It seems quests are more easily picked up in cataclysm dungeons, so this guide type may be obsolete.
so some restrictions on mapping will apply. It will also allow the use of class/role/etc flags. The idea is that the guide should be short enough to be read by a player just before fighting the boss, but this can be changed. so some restrictions on mapping will apply. WoWPro already has several good of such guides:
Though probably some (the lower levels?) will need to be updated or re-written for Cataclysm.
Once I get the addon in a more stable way, I'll provide at least one guide of each type, as an example, and also some instruction on writing dungeon guide for the addon. Again, the format should be quite similar to the Leveling guides, but not completely.
If you have any suggestion/info on the following topics, please post in this thread.
More info and images to come later!
Just a quick blog entry to revisit a WoWPro addon feature...
WoWPro addon has two keybindings implemented, that you can make use of while playing:
By "first" above, I mean from top to bottom on the addon's guide panel, following the guide progression.
Instead of clicking the quest item button associated with the quest "Speaking their language" (shown in the image below), you can use the keybinding to use that item (default: CTRL-SHIFT-I). In this case, the pressed keybinding blows the horn to summon the quilboar's chieftain... *snort*
How to change WoWPro keybindings
Open up the game options frame (ESC), and click on Keybindings.
Scroll all the way down (or almost all the way, depending on other addon's keybindings you might also have) to find the WoWPro keybindings. If you haven't changed the default keybindings yet, you should see something like this:
Then you can change WoWPro's keybindings like any other in the game, including also adding a second key for each.
If you notice any other issue, please feel free to post a reply here or on the addon's general bug report page.
Also, I don't plan (myself) on adding any more keybindings to the addon, but I wrote that part of the code to be easy to expand. So, if any other developer wants to add more keybindings, I'll gladly point you the way.
Good questing! *snort*