Revized WoW-Pro Addon

Jiyambi's picture

WoW-Pro's team is working on our very own addon! Though the initial use will be primarily for leveling guides, the addon will eventually encompass many of the guides which appear on this site.

This does mean we are no longer supporting or updating the old, Tour Guide based guide. In addition, we will only be providing limited support for the old guide files, since most of them will become obsolete when Cataclysm is released (Outland and possibly Northrend being notable exceptions).


The Guide Window

More details about the new addon and awesome screenshots after the break.


Dropdown Menu


Options Page

What we need from the community: First of all, patience. We will do our best to come out with an up to date, new addon quickly, but it will take time.

Secondly, we need input! Please post here with suggestions for features you'd like to see in the new addon.

Thirdly, we need help! The addon is currently in a closed ALPHA stage. Most features work but there are known issues and very few guide files have been converted to the new format. If you are a regular member of WoW-Pro, have some coding experience, and want to help out with alpha testing, please send me a PM.

Once the rest of the basic features have been added, and more guide files have been converted, we will release the addon for an open beta test by all our WoW-Pro users. Our goal is to have a finished, polished addon ready for Cataclysm.

Current Addon Features:

  • Check-able list of steps with detailed descriptions listed below step titles
  • Manual completion enabled for all steps
  • Auto-completion enabled for Accept, Turn-In, and Complete type steps.
  • Coordinate mapping for single coordinates supported through TomTom
  • Sort-able guide list showing zone, author, level range, and amount completed. Now has scrollbar (woopsie!)
  • Guide window is resizeable and can show number of steps from 1-15.
  • Guide list now correctly displays progress for all completed steps, not just manually completed ones.
  • Current guide pane which allows you to scroll through the entire current guide, completed and non-completed steps.
  • Addon automatically queries the server when you log in and updates a database of completed quests, so no progress will be lost even after a client crash.
  • Sticky steps! Used for "do as you go" steps, they appear above the normal step and stay there until completed.
  • New: Auto-completion is now supported for flight, hearth, run, boat, and get flight path steps.

Known Issues (to be fixed)

  • Coordinate mapping only works within the guide's title zone. Multiple zone support to be added soon.
  • Guide window resizing is not smooth and looks rather odd. It can also be resized to too small for 1 step (which means no steps display) or too large for 15 steps (leaving blank space).
  • Auto-completion not yet supported for partial quest complete, set hearth, loot, and use steps.
  • Next guide does not yet automatically load when you finish a guide.

Future Features:

  1. Need to add support for listing certain steps as dependent on multiple quests being completed to be checked off (steps to go to a questing hub, for example)
  2. Use item buttons. We're going with a look similar to quest helper, though may provide a move-able button or a keybinding for the current step similar to that in Tour Guide.
  3. Animation for checking off steps (a check mark appears, old quest fades out, other quests move up).
  4. Either integration of the arrow, or permission from TomTom's author to redistribute their addon, maintaining the author's name and the addon's original name (basically leaving the addon untouched).
  5. Support for area vs. patrol vs. player run path type coordinates.
  6. Display customization (font, font size, colors, amount of info displayed - ability to use mouse-over tooltips instead of displaying the full step)
  7. Support for step skipping (not the same as manual completion) - the guide knows you did NOT complete the quest and will not ask you to complete quests with follow ups. Perhaps has a confirmation message stating "Skipping this step will result in skipping X follow-up steps". Need to add support for quest dependencies for this to work.
  8. Auto-load a guide based on level
  9. A separate "shopping list" frame which can be opened with a button on the title bar, used for a couple things in the leveling guide but which will get the most use for profession guides.
  10. Improved logic/display for multi-objective steps. Not exactly sure how this would work, but perhaps have "substeps" which are displayed together, and checked off as they are completed.
  11. For guide coders, I'd like to see a little more formatting ability for the mouse over notes. There were many times I'd wanted to add new lines to improve readability, and was unable to.
  12. An optional target button, which allows you to target a named mob and places a raid icon above it's head. This will help locate wandering mobs. Ex: |T|Bjomolf| would find the wolf Bjomolf if he is in range, target him, and place a skull above his head so he can be easily located.
  13. Ability for the guide to double as a quest tracker (showing the current quest's completion status) as an option. Example: "Mobs slain: X / Y" would display underneath the |N| text display.

Guide File Updates:
Guide files will be needing some significant updates. You can help us out with these even if you aren't currently working on the addon.

  • Include quest tags for each step (not just quest steps) so they will be auto-completed properly (I understand this was already being done when the addon switch was initiated).
  • Our own coordinates for quest givers and turn ins.
  • Coordinates are no longer listed in the |N| section (that's just for descriptions of the step now). Instead they are listed in the |M| tag like so:

    A Your Place In The World|QID|4641|N|From the NPC in front of you.|M|43.3,68.6|

Possible Future Addons:

  • WoW-Pro Talents - Easy talent recommendations while leveling, for all specs. Possibly include rotation suggestions as well. For players jumping in partway through, it should be able to detect their current talent changes and adjust accordingly, or recommend a respec if the talents are too messed up. Talents should be prioritized to make sure people pick up the most vital ones. Recommendations of glyphs would also be nice.
  • WoW-Pro Dungeons - Guides to dungeons. Easy access while leveling, recommended dungeons for your level and gear. Include gear lists, etc. Step by step guides, preferably with pictures, includes boss kill strategies.
  • WoW-Pro Gold Making - Daily quests, gathering/farming circuits, perhaps even auctioneer advice.
  • WoW-Pro Reputation - Reputation guides created using the addon.
  • WoW-Pro Holiday - Holiday guides created using the addon.
  • WoW-Pro Achievements - Other achievement guides.

Please give us your input! We want to make this addon the best it can be for you, our users. Please let us know what you'd like to see in the new addon!

Comments

No arrow?

First time I logged in with this addon a message popped up with and the waypoint arrow didn't work. Any solutions?

Jiyambi's picture

Do you have TomTom

Do you have TomTom installed? It's currently needed for the arrow to work. I should add a message to warn people that the guide won't work properly if it's not installed.

I will be putting up some sort of error reporting system on the addon's site. I'll post here when that system is in place. For future errors, if you could copy the lua error that occurs that would be helpful.

I do.

I do have TomTom installed. :/ I'll try reinstalling the addon and send you the error.

Suggestion for the Dungeon portion

When it comes time for the Dungeon portion, it would be nice if it could guide you to the entrance when you die.

Jiyambi's picture

Hmmm, seems a good idea. Do

Hmmm, seems a good idea. Do keep in mind that in Cataclysm you will have to discover the dungeon manually before you can teleport to it. However this still may be a good feature since seeing it once doesn't mean you know how to get back to it from the graveyard >_<

I was wondering about the

I was wondering about the Cataclysm part. For example, Dead Mines, would it say I discovered it when I entered that building and went to the entrance area, even though I didn't find the misty door? But yeah, discovering it doesn't mean you remember how to get back.
The Cataclysm guides will need to make sure the player havw found the dungeons at a level appropriate time before it would show up on the Dungeon Finder. I sometimes thought the guides should suggest to do specific dungeons via the Dungeon Finder.. but most of them seem to have been written before the Dungeon Finder became part of the game.

I need testing I like this


I need testing
I like this addons
Pls ^^

Jiyambi's picture

Big Addon Update - Alpha testing in progress!

The information on this page just underwent an overhaul to reflect the current stage of the addon's development. I'm ready to release the addon to a small group of alpha testers. There are still quite a few known issues and features to be added before I can release it to the general public for a beta test. If you are interested in helping out, see the article above for how to do that!

I would love to test the new addon

Im currently trying to get a ton of quests done, dreaming about loremaster, but just working on major city's reputations. Right now I'm doing Teldrassil using the old addon and its not updating properly. Every time I turn in or get a new quest it closes down the "Teldrassil" part in my quest log, and reverts the tour guide widow to a quest i already completed. Can you help, or point me in the right direction.

Jiyambi's picture

I'm not very familiar with

I'm not very familiar with the most recent builds of the Tour Guide based addon Sad I can only assume what's happening is due to miss-tagged QIDs. Anyone more familiar with the old addon able to shed any light?

PS: I'm clearing my weekend schedule so I can spend lots of time this weekend with the addon, should get a ton done, hopefully have it ready for testing by next week!

features

ok, well its not the most recent version of tour guide, well i don't think it is. What i love about the addon most is the guide part and the arrow part. The arrow isn't even that important, except for where to pick up the quests. The blizzard default dots do a pretty good job of telling you where stuff is not. The guide just gives you the most optimized order and routes to do things in.

JamesL85's picture

I'm Off!!!!

My wife and I are leaving for New Zealand for 2 weeks on Sunday. Looking forward to getting back and seeing the new client in action! Although, probably not as much as I'm looking forward to going there!!!! I created a second account and have a couple of low level Hordies that I'll be able to test on that side. I have enough room that I can create some low level Alliance toons to test on that side also.

Screenshots look awesome Jiyambi! Keep up the good work!!!!

James

Have a great time in New

Have a great time in New Zealand. Going to New Zealand has long been a dream of mine.

Jiyambi's picture

Thanks James, have a blast

Thanks James, have a blast in New Zealand Laughing out loud

Jiyambi's picture

Feature Request

Someone *just* posted a comment entitled "Feature Request" that was accidentally deleted with the typical spam comments we get. Please, re-post and I'm terribly sorry. My first mistake doing comment deletions Sad

Malorajan's picture

I was asking if there could

I was asking if there could be a way to have it sync with the WoW servers similar to the way EveryQuest does.
Sometimes I DC and the addon loses my progress.

Jiyambi's picture

This should no longer be a

This should no longer be a problem. I plan to have the addon call the quest history function when you enter the world. However on high level characters this may produce an impractical amount of lag on loading, I just do know yet as I haven't implemented this feature in the current build. If it does prove too laggy, we'll have to only call the history on initial load for a fresh character, but I see no reason not to have an "update quest history" button in the options that will allow you to recover any data that was lost.

PS. I'm proud of myself, I just thought up that work-around on the fly! Laughing out loud Yay for becoming more familiar with addon programming, lol.

Malorajan's picture

Cool ;]

Cool ;]

I browsed your twitter and

I browsed your twitter and saw the screenshots. The addon's looking nice. Smiling

Jiyambi's picture

Hah thanks! I originally

Hah thanks! I originally linked em here but twitpic didn't seem to like that, the urls to the pics changed so I just removed the links. I may upload a few to this site soon though, so everyone can see em more easily.

I agree the shots are

I agree the shots are looking great. Can't wait to start testing (where do we sign up Eye )

Jiyambi's picture

Heh, testing will be soon.

Heh, testing will be soon. Once I feel we're ready to start, I'll have a sign up here.

Unfortunately I had a lot less free time this weekend then expected - I had actually hoped to have something ready by tomorrow! But unfortunately it might not be until next week at this rate Sad

Thanks again for your support Smiling

Instance levelling

Hey there, I really love the idea with the Talents and Dungeons addons, it would probably help a lot of people level through instances. And the other guides sound great too.

I don't know much about computer codes and such, actually nothing at all to be honest, and I do have some RL commitments to do, but I would be happy if there was something minor like to help find a good rotation/talent spec for some classes. I do have a few leveling toons to test on, and I don't mind strating a new one because I enjoy instance leveling quite a lot. Right now I have a Druid, Paladin, Mage who are not 80, and thinking of starting maybe a rogue or a shammy.

Jiyambi's picture

Excellent, more help is

Excellent, more help is always good. We will soon be entering a beta testing phase for the leveling plug in as well as the framework for this addon, and I already have someone offering to start work on the coding for the talent portion. Once that's started, we should be able to get help from users such as yourself who don't have coding experience but want to help with content Smiling

I am really surprised to see

I am really surprised to see the time to time developments here and the way every one is participating in the same. I would like to thank Jiyambi for this and the wonderful work done. I have the Tour guide on my computer . I am feeling very much lucky to be a player of this great game. It’s a good idea to allow the people to leave guide files up for download. People like me will be benefited by it since we can be still able to use the guide. Playground Slides

Jiyambi's picture

Addon Progress Report

Hey all!

Thought I'd give you a little progress report on the addon. Since Ralpb seems to have lost interest in the project, I've been working hard to produce something for us to use.

So far the addon I have created allows you to browse available guides, choose a guide, and view it. It reads the guide files we previously used in our old addon, so we won't have too much to redo on those to make them useful.

Still to do:

  • Add manual and auto completion for the guide
  • Add interaction with TomTom for coordinates (will eventually create our own arrow but using TomTom will let us get a functional addon sooner)
  • Begin adding the new and awesome features suggested by the community, including:
    • Appearance customization (colors, font sizes, title bar)
    • Improved logic for determining next step (based on level, previous quests, etc)
    • Ability to skip steps and have the guide know you haven't completed that quest for the purpose of quest chains

New features already in the addon:

  • Ability to sort guides by zone, level, or author
  • Ability to display multiple steps at a time
  • Ability to display the "note" field of each steps at all times rather than only on mouse-over.
  • Easy access to options using a drop down menu from right-clicking the title bar
  • Resizeable guide window (and moveable, but that's not really new)

As soon as the auto-completion and coordinate features are done, I'll be posting the addon here for people to download, use, and test. I'm still new to coding and lua so I'll be very open to people giving suggestions. But I want to get something at least functional before I have a bunch of people working at it at once.

Jiyambi's picture

No problem Ralpb, I totally

No problem Ralpb, I totally understand how RL can take away WoW time and it's definitely much more important Eye If you would like to help out by sending me the addon files you had completed so far, that would be awesome, but if not that's okay too.

Also to everyone else - I know I said the addon was about ready for beta testing, and it is, however my progress was halted for the last week. A very good friend of mine just came back to the game after a year's absence and I've been using my free time to spend some leveling time with him. However this weekend I should be able to devote a lot of time to addon development. Look forward to it! Laughing out loud

Lycander's picture

Using current guides

Hey, Jiyambi, if we're using the guides from the last release of the WoW-Pro addon, would you like me to correct them as I go along? I'm using them right now, and I've been changing a few things (wrong coords, etc), but I ahven't been consistent. I have no problem updating as I play, so if you'd like me to work on updating the Alliance guides I can do that, at least from level 30 up. Let me know. Thanks.

Jiyambi's picture

Lycander - that would be

Lycander - that would be awesome. We are going to be *starting* with the old guide files. I am making a few changes however. First of all, coordinates will no longer be listed in the |N| note section and instead be listed in their own |M| section (I know M is a bit confusing but it was the only one I could think of that wasn't used, think M for map).

Example:

A Your Place In The World|QID|4641|N|From the NPC in front of you.|M|43.3,68.6|

The second change is that we are going to be moving away from using LightHeaded because people just had issues going to another site and downloading it. So we'll need to start hard-coding quest accept and turn in steps, as shown in my example above.

Now, this doesn't need to happen all at once but these are some things that will eventually help us out, so if you feel like working on them as you go, feel free Smiling

Lycander's picture

You got it, Jiyambi. I'll

You got it, Jiyambi. I'll start updating as I play. Will your new format work in the Tourguide ones, or should i just update and hard-code coordinates?

Jiyambi's picture

My new format won't *break*

My new format won't *break* with Tour Guide reading the file, but Tour Guide won't map coordinates unless they are listed in the |N| section. For now you could simply add them to the new |M| section and also leave them in the |N| section, if that seems do-able.

Example:

A Your Place In The World|QID|4641|N|From the NPC in front of you. (43.3,68.6)|M|43.3,68.6|

I am going to guess |N| is

I am going to guess |N| is now for Notes of some type, differing from the old style note?
Changing the |N| to |M| should be easy enough, and a simple find/replace should work for that on the old ones. Though that won't fix it when they have the wrong coordinates. Which sort of brings up another issue.
Do we want to spend much time fixing coordinates, changing quests that are no longer valid, etc. if Cataclysm will move everything around anyhow. Even for those who don't buy the expansion, the patch itself will force the zone changes on everyone. Then again Cataclysm may not be out until November so we may want the guides to be as accurate as possible until then.

Jiyambi's picture

To point 1: |N| is just as

To point 1: |N| is just as it always has been, for notes explaining the quest objective. In the past it has ALSO contained the coords which are mapped through TomTom. I find this has often cluttered up this note section, and with out improved display customizability this creates some issues. This is why I made the decision to move the mapped coordinates to a separate tag, hence |M|.

In short: No, sadly find/replace won't really work - it will take away any other helpful text that the |N| tag originally had in it.

To point 2: While fixing current guides is no longer a particularly high priority, I would like to have a few of them fixed up so we can use them to test the addon and make sure it's working properly before Cata hits.

In short: No, fixing these isn't really important unless you really feel like working on something for the site, I will be able to fix up enough to test myself if no one else gets around to it. But it is a help if you feel the urge Eye

I may take a stab at working

I may take a stab at working on some of the 1-12 type guides once the beta testing starts (not sure my coding skills warrant alpha testing). I started fixing Boston's Gnome/Dwarf guide (it had a bug with the A Refugee's Quandary quests). I could go back in and start trying to add coordinates and such...
I see what you mean that a search/replace won't work.

So the |Z| tag isn't working in the new guide yet but will? I should think we would want that, even for turn in/accepts. That way we are not dependent on lightheaded.

Jiyambi's picture

Yeah, the |Z| will be

Yeah, the |Z| will be implemented but I just haven't gotten to it yet. Wanted to get the very most basic things done first.

Also to those who messaged me as interested in alpha testing - I'll send pms out shortly with the info Smiling

Jiyambi's picture

Real Time Updates

If you want to get updates of my progress on the addon in real time, you can follow me on twitter.

Do you still need help with

Do you still need help with the AddOn?
I sent you a message in February but never got a reply.

Jiyambi's picture

Sorry about that, got a lot

Sorry about that, got a lot of messages around that time and must have let yours slip by! Shocked

It depends on what you mean by "help". I really think it best if one person builds the foundation of the addon, I just don't think it would be feasible to have multiple people working on it at the moment.

However, once I have some sort of beta ready, it could use all sorts of testing and additions. Plus people to work on the "plugins" I described up above.

WoW-Pro Talents

I could help with the Talents plugin. I just started writing a very lightweight Talented AddOn for personal use, but I would love to contribute to this project Smiling

Jiyambi's picture

That would be awesome! I'll

That would be awesome! I'll send you a PM with some info and we can discuss from there Smiling

Malorajan's picture

I'd love to help in anyway

I'd love to help in anyway possible with creating or assisting in the creation of an addon.
I assume knowledge of LUA and XML is all that is really required for the most part?

Jiyambi's picture

Malorajan - knowledge of LUA

Malorajan - knowledge of LUA and XML would be required to write the addon itself, and would assist in debugging - however writing guide files will not require any knowledge of programming languages. We plan to use a system somewhat similar to Tour Guide's for the "language" of guide files, so it shouldn't be too hard for non-programmers to help out.

Malorajan's picture

Sounds good, just running

Sounds good, just running around the website I found http://wow-pro.com/general_guides/jahwos_addon_writing and so I'm going to be looking at trying to learn a little bit and see what I can do.

love to help as well

I don't have a ton of time as I'm a full time IT administrator, but I would give my best.

drdead's picture

http://forums.worldofwarcraft

http://forums.worldofwarcraft.com/thread.html?topicId=16102301679&sid=1

I dont see what's the problem. 1st and 2nd parts are actually allowing every1 to freely distribute and modify any existing addon. Besides it's restricted to make addon part of the thing u pay for.

tinkerboon's picture

No. 1 only mandates that the

No. 1 only mandates that the addon must be given away for free by the original author. That does not imply a right to re-distribute it. And 2 only says that all the programming code must be completely viewable. That does not mean you are allowed to change it.

drdead's picture

"1 only mandates that the

"1 only mandates that the addon must be given away for free by the original author."

According to tekkub's blog he didnt give away it for free. Why should it be pay-to-use?

tinkerboon's picture

You confuse the right to use

You confuse the right to use the addon (this has to be free, and TourGuide is currently distributed for free by tekkub/zygor via curse etc.) and the right to re-distribute it (which is not neccessarily free, and thus tekkub could charge $$$ from zygor). This means that any end-user can download TourGuide for free, however, WoW-Pro is not allowed to distribute it (or modify it)

I would like it if the addon

I would like it if the addon would send you to pick up prerequisite quests for someone who doesn't use it from the beginning. If someone starts at level 41, it would send them to pickup quests that would help them progress in the current guide (within reason of course). You shouldn't have to complete a 10 part quest series that is gray just to get to a green quest that isn't important, but if you can't pick up 1/3 of the quests in an area due to prereqs, then it would be nice to have it list them first.

Jiyambi's picture

This is definitely something

This is definitely something we want to add into the new addon. It may not be in the first release, but it is a feature that's very important and will definitely come along eventually.