Download
(36Kb)
Download
Updated: 08-28-08 11:31 AM
Pictures
File Info
Updated:08-28-08 11:31 AM
Created:unknown
Downloads:3,700
Favorites:53
MD5:

The Traveller's Reference

Version: 2.4.3-1.7
by: VagrantEsha [More]

The Traveller's Reference: A DataBroker Plugin

The Traveller's Reference is an easy to use guide to provide you with information about the current zone you're in, and pointers to other places you could go. This mod is also a DataBroker plugin, which means there are many ways in which you can display this information (see the section below for DataBroker information).

Here's the bulleted feature list.

The information display (see screenshot):

- Shows the zone you're currently in and the level-range of that zone is shown.
- The display style can be toggled between two modes via alt + click.
- Long display: Shows the zone, sub-zone in brackets, then the level-range.
- Short display: Shows the sub-zone if present, otherwise the zone, then the level-range.
- Shift + clicking the display will toggle showing the range.
- Control + clicking the display toggles plugin-dragging mode*.
- Clicking the display opens/closes the World Map.

* When in this mode, the tooltip is mode small and most click based operations are disabled. This is in order to make the plugin easier to drag into position.

The tooltip (see screenshot):

- A list of neighbouring zones (zones that border the one you're currently in).
- A list of instances within your level-range.
- A list of zones within your level-range.
- The level-ranges are colour-coded so they can be easily recognised at a glance.
- Holding shift makes the tooltip small, for ease of movement.

Credits

I'd like to thank Beoko, I helped work on his Navigator plugin and I learned a lot from doing so, some of that is present in The Traveller's Reference. Navigator was instrumental in helping me set foot down the road of DataBroker plugin creation in general, too. So really, kudos to him. Check out his Navigator mod!

What is DataBroker?

DataBroker is part of a system that's similar to FuBar and its plugins, what you have here is a plugin but you'll also need something to display the output of the plugin. You have many options for this, and I've listed a number of them below for your perusal, just pick the one that interests you the most.

- Fortress: http://www.wowinterface.com/downloads/info10401-Fortress.html
- ButtonBin: http://www.wowinterface.com/downloads/info10474-ButtonBin.html
- StatBlockCore: http://www.wowinterface.com/downloads/info9221-StatBlockCore.html
- MakeRocketGoNow: http://www.wowinterface.com/downloads/info9771-MakeRocketGoNow.html
- Carousel: http://www.wowinterface.com/downloads/info10295-Carousel.html
- Titan: http://www.wowinterface.com/downloads/info8092-TitanPanel.html

If you want further information, that nice feller tekkub has put together some information on his wiki. And it's good information too, information that you should probably read if you're just getting into DataBroker plugins. (Not to mention that poor old tek puts these pages together and not many people seem to read them, so I thought I'd do my part to help remedy that situation. )

http://github.com/tekkub/libdatabroker-1-1/wikis

2.4.3-1.7

- Previously, for areas that didn't require a level range (such as a city), The Traveller's Reference would report 0-0 as the range. This has been changed. It now reports 1-70 as the range, which is more apt (and 1-80 in Wrath).

2.4.3-1.6

- The colour has been removed from the toc name, as this caused issues with alphabetical categorisation.

2.4.3-1.5

- I've got a new direction with the tooltips, it took me a while to decide on this. It was discussed with a few people too and it was generally and mutually decided that the new direction I'm taking them in is better. So this is the New Unification of Tooltip Styles for my plugins. NUTS v1! I'm pretty much going to model all my DataBroker plugins after this layout, to try to keep them as easy to understand at a glance as possible. The basic idea is: Keybinds at the bottom, the most important information at the top, and all the straggler-lines cushioned in the middle. Credit where credit is due, too; this all started because of a suggestion by Nyte, so kudos for Nyte for giving me reason to think about all this! This is far too long for a changelog update, I know... but necessary!
- I've corrected the toc-version, I am scared and confused by toc-versions.

2.4.3-1.4

- Redid the tooltip a little, the line explaining what the columns are has been removed (it was redundant anyway and looked out of place), and the line stating what the level range of the current zone is has been moved below the keybinds.

2.4.3-1.3

- Shift + Click will now toggle showing the range on the information display.
- Control + Click will toggle plugin-dragging mode, which makes the tooltip much smaller and disables most click-based functionality in order to make the plugin easier to drag.
- A new settings system is in place, so your setting for the zone/sub-zone display style will be lost, sorry. No further changes of this type should be necessary though, I'd hope.

2.4.3-1.2

- I realised the first square bracket was misbehaving with its colour too. Bugger. Fixed that aswell.

2.4.3-1.1

- Fixed the last bracket in the information display being oddly coloured. Thanks to OttoDeFe for the heads-up.

2.4.3-1.0

- First release on WoWI.
Post A Reply Comment Options
Unread 08-26-08, 01:11 PM  
Nyte
A Fallenroot Satyr
AddOn Author - Click to view AddOns

Forum posts: 20
File comments: 107
Uploads: 1
Vagrant, thank you very much for developing and updating this plugin. I love it and use it, and hope you are able to populate it for Wrath.

Thank you also for including Titan Panel in your list of display handlers. TTR does work quite well in Titan.

May I make a couple of suggestions about the tooltip?
1. I think the table columns are self-explanatory, so I'd suggest removing the column headings (Name - Area Continent) to reduce the amount of real estate used by the tooltip.
2. I suggest moving the green hint/help text to the bottom of the tooltip and making the text green also. Doing so will group the info the user is looking for: Current Zone and Level Range, Bordering Zones, Level Range Instances, and Level Range Zones; and although the hint/help text will be at the bottom, the text color will still allow it to stand out.

Regardless of whether you implement my suggestions, I will continue using and recommending your most excellent plugin.

Nyte
__________________
Beware of the Nyte!
Report comment to moderator  
Reply With Quote
Unread 08-26-08, 01:28 PM  
VagrantEsha
Token Werewolf Fan
 
VagrantEsha's Avatar
Premium Member
AddOn Author - Click to view AddOns

Forum posts: 27
File comments: 238
Uploads: 38
@Nyte

1. Fair point, will do.

2. This is more complicated. I've done it that way because it's uniform with all my other plugins, if you look at the other DataBroker plugins I have up on WoWI, they all have exactly the same kind of display. I did this so that when someone looks at one of the tooltips of my plugins, they know exactly what to expect.

The problem this presents me with is that I'd have to do this with all of my mods to keep that uniform appearance, as opposed to The Traveller's Reference. I'd have to put the information above, and the help text at the bottom in every other tooltip. Otherwise The Traveller's Reference is going to be a black sheep that doesn't match the conformity of my other mods, and it's going to stand out and look ugly because of that.

I'm not saying I won't move them, it's just that it's going to be a bit of an undertaking to change all of my tooltips and keep them uniform again. I'll look into it though.

As for the colour... that's one thing I don't want to do. I hate to say an outright 'no' but again, this is all a part of the visual representation of my mods. When I have something that outputs to the chat frame, it's always "Source: Information", separated by colours to make it easy to read and distinguish one from the other. All the 'information' text is always white (unless it specifically has to be another colour), key bindings are in green, and 'source' information elements (such as This does This) are always in yellow.

The problem with drastically reshaping the tooltip is that it effects more than just The Traveller's Reference. So to bring it to a close... I really don't want to change the colours, but I will consider moving the help text. And I will remove that line saying what the columns are (you were right about that).
Report comment to moderator  
Reply With Quote
Unread 08-26-08, 01:44 PM  
VagrantEsha
Token Werewolf Fan
 
VagrantEsha's Avatar
Premium Member
AddOn Author - Click to view AddOns

Forum posts: 27
File comments: 238
Uploads: 38
Okay, I've removed the columns explanation line from the tooltip, moved another line... and it does look a little bit nicer.

Still pondering the fate of those keybind lines, though...

---

Oh, my bad. I just noticed that I had the keybindings at the bottom with Junkie, I forgot about that. So it's either a matter of going with the Junkie visual approach, or that of the rest of my mods.

I'll probably end up going with the Junkie approach and put the keybind text at the bottom. But that's five mods to update... and not tonight. It's 9PM here and I'm going to watch some TeeVee before heading to bed. I'll tackle it in the morning.

So... the only thing that won't be implemented from those requests is the colour change. But everything else will get in.
Last edited by VagrantEsha : 08-26-08 at 02:05 PM.
Report comment to moderator  
Reply With Quote
Unread 08-26-08, 07:39 PM  
Nyte
A Fallenroot Satyr
AddOn Author - Click to view AddOns

Forum posts: 20
File comments: 107
Uploads: 1
Vagrant, they were just suggestions; the fact that you considered them is satisfaction enough.

Nyte
__________________
Beware of the Nyte!
Report comment to moderator  
Reply With Quote
Unread 08-26-08, 10:53 PM  
VagrantEsha
Token Werewolf Fan
 
VagrantEsha's Avatar
Premium Member
AddOn Author - Click to view AddOns

Forum posts: 27
File comments: 238
Uploads: 38
@Nyte

True.

But the thing is, the more I looked at the plugins I realised you were right. In fact, I already have a new look for the tooltips of the plugins waiting in the wings. I'll roll them out a little later, as soon as I have the new screenshots.
Report comment to moderator  
Reply With Quote
Unread 08-28-08, 09:06 AM  
Nyte
A Fallenroot Satyr
AddOn Author - Click to view AddOns

Forum posts: 20
File comments: 107
Uploads: 1
May I make two more suggestions?

The first concerns the level range both on the button and in the tooltip. Currently, when you're in an area without a level range in the table, e.g., Stormwind, Dwarven District, "0-0" is displayed. Would you change this? One option would be to blank it on the button and return "None" on the tooltip; another option would be to return "0-70" in both places.

The second suggestion concerns the keybindings listed in the tooltip. The current order is: Click, Alt-Click, Shift-Click, Ctrl-Click. I suggest rearranging them to Click, Shift-Click, Ctrl-Click, Alt-Click. Although a minor thing, I think listing them in the order in which the keys are on the keyboard makes the keystroke combination easier (and faster) to "find". (In the current order, I find myself looking for the keys.)

Thanks,
Nyte
__________________
Beware of the Nyte!
Report comment to moderator  
Reply With Quote
Unread 08-28-08, 10:52 AM  
VagrantEsha
Token Werewolf Fan
 
VagrantEsha's Avatar
Premium Member
AddOn Author - Click to view AddOns

Forum posts: 27
File comments: 238
Uploads: 38
The first concerns the level range both on the button and in the tooltip. Currently, when you're in an area without a level range in the table, e.g., Stormwind, Dwarven District, "0-0" is displayed. Would you change this? One option would be to blank it on the button and return "None" on the tooltip; another option would be to return "0-70" in both places.
I'll opt for the 1-70 (or 80, in Wrath) option, as that's the best choice aesthetically.

The second suggestion concerns the keybindings listed in the tooltip. The current order is: Click, Alt-Click, Shift-Click, Ctrl-Click. I suggest rearranging them to Click, Shift-Click, Ctrl-Click, Alt-Click. Although a minor thing, I think listing them in the order in which the keys are on the keyboard makes the keystroke combination easier (and faster) to "find". (In the current order, I find myself looking for the keys.)
I actually listed them that way because it makes the tooltip look the nicest (shortest to longest), but I'll consider this.
Report comment to moderator  
Reply With Quote
Unread 08-28-08, 11:32 AM  
Nyte
A Fallenroot Satyr
AddOn Author - Click to view AddOns

Forum posts: 20
File comments: 107
Uploads: 1
Originally posted by VagrantEsha
I actually listed them that way because it makes the tooltip look the nicest (shortest to longest)
When I doublechecked the tooltip while composing the message, I noticed that and assumed that was why.

Nyte
__________________
Beware of the Nyte!
Report comment to moderator  
Reply With Quote
Unread 09-13-08, 07:28 PM  
Torhal
A Pyroguard Emberseer
 
Torhal's Avatar
AddOn Author - Click to view AddOns

Forum posts: 1196
File comments: 223
Uploads: 34
Originally posted by VagrantEsha
I'll opt for the 1-70 (or 80, in Wrath) option, as that's the best choice aesthetically.



I actually listed them that way because it makes the tooltip look the nicest (shortest to longest), but I'll consider this.
Or, you could make it display "City". Aesthetically better than "None" and adequately (and implicitly) explains 1-70. Unless, of course, it's easier code-wise to display it numerically. Although, with future expansions, you'd have to update the max level range manually as it goes up (which I'm assuming it will), so the "City" option may be easiest in the long run.
Report comment to moderator  
Reply With Quote
Unread 09-16-08, 08:01 AM  
Vytae
A Murloc Raider

Forum posts: 6
File comments: 62
Uploads: 0
Small suggestion

how hard would it be to put the fishing skill for the zone in the dropdown box? I switched from locationFu to this and that seems to be the only real thing I miss.
Report comment to moderator  
Reply With Quote
Unread 09-26-08, 11:26 PM  
joshwill80
A Murloc Raider

Forum posts: 5
File comments: 144
Uploads: 0
couple of things

a few things i would like to see that were features in the fubar plugins that were similar to this addon:

-option to hide battlegrounds from recommended instances
-option to set how many levels you want to see below or above you. for example setting the level threshold to 3 on a lv 30 character would only show you zones and instances that are 27-33. on my lv 70 characters i only want to see zones/instances that are 67-70.

both of these would help to clean up the tooltip display for those of us that want to.
Report comment to moderator  
Reply With Quote
Unread 11-13-08, 01:12 AM  
Allara
A Kobold Labourer
 
Allara's Avatar
Premium Member
AddOn Author - Click to view AddOns

Forum posts: 1
File comments: 123
Uploads: 1
I'm curious, have you by chance tested this with Broker2FuBar? I checked briefly and it didn't seem to show up. I'll glance at your code tomorrow, but one of the things that tends to help is if you add type = "data source" to your LDB object. Like I said, I'll check tomorrow to see if that is the problem here. I'm actually still using FuBar (yes, yes, I know), but I love LDB plugins because they are so lightweight. Thanks!
Report comment to moderator  
Reply With Quote
Unread 12-03-08, 10:09 PM  
Caliban7263
A Kobold Labourer

Forum posts: 0
File comments: 19
Uploads: 1
3 months without a comment or update from the author - Northrend zones not included in the current version.
Report comment to moderator  
Reply With Quote
Unread 01-11-09, 10:39 PM  
Sepioth
A Molten Giant
AddOn Author - Click to view AddOns

Forum posts: 894
File comments: 97
Uploads: 2
Would it be possible to put a key modifier on the tooltip??

Say maybe a Shift+Mouseover ... or even a "click to show tooltip"

I constantly mouse over the location and get the huge info window covering everything. Kinda annoying.


NM -- I added the code myself. Made it so Shift has to be held to show the tooltip.
Last edited by Sepioth : 01-21-09 at 08:48 PM.
Report comment to moderator  
Reply With Quote
Unread 01-12-09, 07:37 PM  
Wizardling
A Kobold Labourer
 
Wizardling's Avatar
Premium Member

Forum posts: 0
File comments: 119
Uploads: 0
Question Alive?

Is this plugin alive? It's really handy so I hope the author updates it

Just in case it's not completely dead I'd really appreciate a click key combo to open Atlas *hopeful*
Last edited by Wizardling : 01-12-09 at 07:41 PM.
Report comment to moderator  
Reply With Quote
Post A Reply



Category Jump: