NotesUNeed

NotesUNeed v6.63.33500 - Adrill of Eonar (US)
Originally created by Telic of Dragonblight (EU)
___________________________________________________

- fixed ChatFrameEditBox issue as reported by ameyaselene. Thanks for the great bug report.

Additionally, if anyone else would additionally be interested in working on maintaining this mod with me, I am looking in to setting NuN up on a repository to allow multiple contributors to work on it. PM me if you want to get involved.

Make Contact Notes on other Players, or General Notes on anything else.

This AddOn is for making your own custom notes on players, and quests, and items, etc. and does not come with any pre-made notes.
It does provide an Export and Import Feature for sharing of sets of notes, or publishing of note databases.

There is no longer an "Alternative" version of NuN, and the default Modifier keys for creating notes from Container Items and Hyperlinks is now simply "<Alt>-Left Mouse Click". For anyone unhappy with this key-Combo, then they can now specify their own via the NotesUNeed Options frame.

Below is a summary of NotesUNeed functionality, but you should read the Readme.txt file for much more detailed discussion on these subjects.

Main Features of NuN
--------------------

1.) Create Player Notes (aka Contact Notes) :
- Create Contact notes :
a) using new NuN buttons in the Friends Frame
b) using the NuN Micro Buttons described in point 3
c) using slash commands
d) via new NuN options in the player context menu
e) Or via any of the automated methods mentioned below
- NuN can auto-populate many details about race, class, guild, etc.
- Also add your own free Text notes
- auto maintain Friend / Ignore Lists across different Alts
- auto-note people you Party with
- auto-note Guild members
- auto maintain notes on your own Characters plus Levelling notes
- Rate Players via Right click menu and see that Rating in Tooltips
or tagged to Player Names in Chat

2.) Create General text notes on anything you like :
- Create General notes :
a) via the Micro Buttons in point 3 below;
b) via slash commands;
c) use the NuN Modifier when clicking on Container Items or Hyperlinks
(Default "<Alt>-Left Mouse Click" but can be changed in Options)
d) importing from a Plugin database
e) receiving notes in-game from other NuN users
f) Or via any of the automated methods below
- Options to auto maintain Quest Notes which will save a few kinds of notes
a) Quest notes that record quest details plus Quest Giver name and location
b) Quest progress notes which record location when completing quest objectives
c) Quest History detailing when a given Toon Accepted, and Completed quests
- General notes can be saved at Account or Realm level
- Scripting - LUA scripts can be executed from General notes by :
a) Using the Run Script button in the frame
b) Slash command "/nun -x <NOTE_NAME>"
c) Execute one NuN Note from another NuN Note with the following command :
NuN_ExecuteNote("<Note Name>")
- General notes can be assigned the following Types for easy searching :
a) ITM - Item notes
b) QST - Quest notes, and quest objective notes
c) NPC - Notes made on NPCs and Mobs
d) LOG - NotesUNeed records Transmission logs when you send/receive notes
e) LUA - Keep your own in-game scripts library and execute notes like Macros
f) - or just leave blank ;p

3.) NuN has a MicroButtons panel with 4 buttons for quick access to features.
This frame can be moved by dragging the small border surrounding the buttons, and can be hidden if not needed (see slash commands). From left to right the buttons are :
- Options : toggle the NuN Options frame
- Note Browser : toggle the NuN Note Browser frame
<Alt> Left Click to browse General notes only
Right Click to browse Quest History
- Contact Note : create a note for the current target
will create a General note if current target is an NPC
<Alt> Click to re-open the last opened Contact Note
- General Note : create a General note
will create an NPC note if current target is an NPC
<Alt> Click to re-open the last opened General Note

4.) Note Browser Window.
This is where you can view the list of notes you have :
- default sorting is your Faction, then Opposing, then General Notes
- search for notes containing text you specify in the edit box
a) Left click : Case insensitive search
b) Right click : Case sensitive search
- filter visible notes from the Options Frame
e.g. to only show Quest Notes, or NPC Notes
- a tick indicates a General note is saved at Account level
- hover over a note to see its contents in a Tooltip
- Right-Click to open the sticky NuN PinUp Tooltip
- <Shift>Left-Click to paste the note name in to open chat box
- After filtering and searching to narrow down the visible set of Notes, you can :
a) Mass delete those listed in the browser frame
b) Export listed notes for other players to install and Import

5.) Options frame - open via the Microbuttons or slash command "/nun"
Configure NotesUNeed here, or filter the notes to appear in the Note
Browser frame. For example, to just look at NPC notes, or browse
Quest History for one of your Toons

6.) Backup and Restore functionality to save your database
This functionality is kept in separate LoadOnDemand AddOns to save memory.
Both the Backup and Restore processes will execute a ReloadUI()

7.) Import and Export of notes Databases
Share sets of notes with friends, or publish notes databases as a Plugin
for others to Import

8.) Broadcasting & Sending of NotesUNeed Notes
Broadcast Raid Instructions for Boss enchounters or PvP strategy, or
just your enchant selling menu; Or send formatted notes for other
NotesUNeed users to add to their database.

/nun <note title> : Will attempt the following :
1. Fetch a saved Contact note with that name
2. Fetch a saved General note with that title
3. Create a new Contact note if a player of that name is in your party/raid group or is within target range
4. Toggles the NotesUNeed Options window

/nun -t : Fetches the saved Contact note for the current target, or creates a new one, or shows your own characters note if no valid target. Since v2.00.1800, this command will create notes for NPCs and populate some basic information about them.

/nun -g : Creates a new General Note, untitled.

/nun -g <note title> : Fetches the existing General note with that title, or Creates a new General note with that title.

/nun -ch <name> : Create a Horde Player Character note for the given name without validating it
/nun -ca <name> : Create an Alliance Player Character note for the given name without validating it

/nun -tt : Toggle NotesUNeed Tooltips on/off

/nun -micro : Toggle the NotesUNeed Microbuttons panel hide/show

/nun -x <note title> : Tries to execute the specified note as a Lua Script. If no note exists, then will open the Note Search window

/nun -i <name> : to stop NotesUNeed trying to ignore a player

/nun -f <name> : to stop NotesUNeed trying to befriend a player

/nun -resetlists : to reset NotesUNeed's Friend/Ignore lists to those of the currently logged Alt

/nun -purgeexport : to clear Exported records and allow the creation of a newly named set of records

/nun -delay [number of seconds] : transmissions to channels have a default delay between each line being sent of 0.33 Use this slash command to change this value. Will report the current value if you do not pass any seconds value.

where -
"NOTE_NAME" = the name of the note or note title
"SEND_METHOD" = how to send the note e.g. "GUILD", "RAID", "WHISPER", "CHANNEL", etc.
"SEND_PARAMETER" = Optionally required (i.e. who to WHISPER to -OR- the Channel ID/Name)
NOTE: using any of these slash commands will close any currently open note.

Changes in v6.63.33500 from v6.62.30500
---------------------------------------

- fixed ChatFrameEditBox issue as reported by ameyaselene. Thanks for the great bug report.

The Special Notes section at the very top of the Readme.txt file, and at the very top of the AddOn Description above mentions how to create notes based on items, and how to put Hyperlinks in to Notes.

i.e. the last sentance specifically
"If you have a NotesUNeed note already open when using the above functionality, then a Link to the item will be pasted in to the open note, rather than a new note created."

So, for example if there is a Hyperlink in the Chat Frame, then open the note you want to paste it in to, put the text cursor at the point you want to insert the Hyperlink, and <Alt>-<Shift>-Click on the Hyperlink.

However, Blizzard functionality means you can NOT 'click' on Hyperlinks in Edit Boxes - so you can't 'click' on Hyperlinks in NotesUNeed notes and see the tooltip - the Chat Frame scroll window is NOT an Edit Box, but obviously the text section of NotesUNeed notes HAS TO BE an Edit Box...
If you want to access the Hyperlinks in a NotesUNeed note, then use the "[]" (Hyperlink) button in the top right corner of Note edit windows, and the Hyperlinks contained in a note will be echoed to the Chat Frame where you can click on them to display tooltips or paste in to other Chat Frame messages.

Changes in v5.56.20003 from v5.55.20003
-------------------------------------------------

- small change to the behaviour of the MapNotes NotesUNeed Tooltips
The NotesUNeed Popup list of Notes will now disappear immediately when your Mouse leaves a MapNote.
If you want the List to stay Open so that you can view the NotesUNeed Tooltip for individual notes, or Click on the Note to open it, then hold down the <Control> key and the NotesUNeed Popup list of notes will stay open.

- small change to Quest Recording to make sure Notes are created more promptly when accepting quests

- double check to prevent a rare error when logging in with other Quest AddOns installed

Changes in v5.55.20003 from v5.50.20003
-------------------------------------------------

- added basic ability to change the font used in Edit Boxes where you type text
Basically, I have supplied an alternative font that can be used in game by Ticking the new "NuN Font" Check Box Option.
The supplied font is the free Vera Sans Mono (True Type) font - a monospaced font that simplifies text allignment e.g. in Script style notes.
If you want to use your own Font when editing notes, then simply copy your font in to the following directory and re-name it to "NuN.ttf"
Interface\AddOns\NotesUNeed\Artwork

- corrected a problem with the Friend/Ignore list functionality when targetting the individual, and now make sure note symbols are updated immediately

- double checks now in place to make sure you can NOT delete Friend/Ignore Notes if using NotesUNeed to automatically maintain Friend/Ignore Lists

Changes in v5.50.20003 from v5.47.20003
-------------------------------------------------

- fixed the Quest Log problems that were broken by a recent Blizzard Patch

- change to MapNotes-NotesUNeed Tooltip Functionality :
Previously there would be delay when displaying the MapNotes-NotesUNeed Popup frame which would prevent it from closing when your mouse leaves the MapNote, therefore allowing you time to click on the NotesUNeed button to open the Note - this delay would also prevent the Popup frame from closing if you moused over another MapNote - this affect was also deliberate to allow the user to access the NotesUNeed button; i.e. the button would disappear if the route of the mouse from the initial MapNote to the NotesUNeed button passed over another MapNote.
Anyway to cut a long story short, I have now changed this functionality. There is still a delay leaving the NotesUNeed buttons available to click when your mouse leaves a MapNote - But the tooltip and NotesUNeed Popup frame will refresh immediately when you mouse over any other MapNote.
If you are having trouble clicking on a NotesUNeed Popup button for one MapNote, because you can't avoid mousing over other MapNotes to get to it - then hold down the <Control> Key, and Mousing over other MapNotes will be suppressed.

- Doh! Forgot to add the Paladin/Shaman classes that are now available to Horde/Alliance respectively

- fixed the NPC Information fetching routine to make sure Professions are fetched correctly
(Note, I have not tested with other GameTooltip Modifications installed - the code still relies on the Profession being recorded on the second line of the Tooltip, so if another AddOn has hidden or moved this information to a different line of the tooltip, then I don't have any plans to address that as a NotesUNeed issue; There could just be too many options for me to cater for given the number of Tooltip AddOns available.)

* updated the Race and Profession drop down boxes to include Burning Crusade options

(I've been very lazy and just added the new races/professions after the last entries in the drop down boxes, rathter than re-arranging in alphabetical order - it means I don't have to write a conversion routine to update old notes, or during note exchange between different language clients) NOTE : Sending of Contact style notes to users of older versions of NotesUNeed is unsafe where the Contact references one of the new Races/Professions

Yeah, I have heard this problem from someone else - NotesUNeed resets the map when you complete quest objectives;
But EQL3 calls the Blizzard function every 3 seconds that only normally gets called when you complete Quest Objectives - not sure why it can't wait for normal calls when objectives are really completed.

Anyway, I have a fix in the next release of NotesUNeed to make sure I only reset the map when a Quest Objective is ACTUALLY completed, and not just when some other AddOn is triggering the function

It looks like when both NotesUNeed and Extended Quest Log are installed, the world map is reset to the current zone after about 5 seconds. Either mod installed on it's own work fine and the world map is not affected.

Changes in v5.45.20000 from v5.42.20000
---------------------------------------

- NEW Microbutton functionality.
1.) can now quickly access Quest History notes by Right-Clicking on Search Microbutton (i.e. the Magnifying glass)
2.) can now quickly access the list of General Notes by Alt-LeftClicking on the Search Microbutton

- Chat Frame Hooks changed which should fix problems connected to Pet Bars and handling, when pets are summoned during combat

- With a Mob/NPC targetted, using either the Player or General Microbutton will open/create a note for that Mob/NPC

- when noting completion of Quest objectives, Zero messages will be ignored as they aren't useful and just take up space

- fixed the bug of the Save button not working for general notes if still editing the title (withouth ever having moved the text cursor to the main body of text) Hopefully that should fix the problem as it was reported. (Thanks to Giddily for the Pic.

Changes in v5.42.20000 from v5.40.20000
---------------------------------------

- updated more function hooks to ensure secure hooking is used where indicated by function attributes. Especially for PaperDoll frame, but also even if no visible errors were noted previously.
(Should fix the Blocked Action error when using Items directly from the Character sheet)

- fixed the ability to create notes from the character sheet
NOTE : ONLY need to <Alt><Left Click> on Character sheet items to create/paste in to NotesUNeed notes.
(i.e. no need to use the <Shift> key on Character sheet items, and users of the Alternate version of NotesUNeed should also simply <Alt><Left Click>)

- fixed a small issue when clicking on Ignored players in the Social frame to make sure any open Contact note is updated - as per functionality on the other pages of the Social frame.

- fixed a small bug when deleting Quest History entries by Right Clicking and confirming deletion

NOTE: Again, PetDismiss and Duel errors can't be fixed (as far as I know) without removing the Right click Player Rating functionality; Sorry, but I'm not willing to remove the functionality atm, only to have to put it back in again when Blizzard fix the issues in their next patch. So check the "NotesUNeed and WoW2.xx.txt" file included in the archive - or check earlier Patch notes below for more details.

Changes in v5.40.20000 from v5.30.20000
---------------------------------------

- NotesUNeed will now record the locations where Quest Objectives/Items were achieved/dropped if you are auto-noting Quests
For example if a quest is called "Kobold Camp Cleanup" and you are auto-noting Quests, then NotesUNeed will record 2 notes for the Quest.
One called "Kobold Camp Cleanup" which stores the quest details from each stage of the quest; And one called "Kobold Camp Cleanup:Objectives" which will record your Map locations when objectives were completed / quest items received.
Character specific details of when you Accepted, Completed and Handed In a quest on a given character is still only available when browsing QuestHistory while logged in as that character - by viewing the toolip when mousing over the list of quests after selecting to Search for NotesUNeed QuestHistory from the Options frame.

- as a result of some old changes in previous versions (forced by changes in WoW), new line characters (carriage returns) now use up 2 characters in the text box.
Because of this, the number of characters being reported in the NotesUNeed edit boxes has not been an accurate guide, but this has now been fixed.

NOTE: it seems that the WoW Patch 2.02 may never arrive, so included here are further compatibility changes for WoW Patch 2.xx

- fixed the Blocked Action issues when using/disenchanting bag items

- PetDismiss problems have been fixed in the latest Burning Crusade Beta, and there doesn't seem to be a way for me to fix them until the Blizzard patch is released (without removing the Right Click Menu Player Rating buttons).
The problem can be avoided by NOT using the NotesUNeed Right Click Player Rating functionality. (Sadly, you can't even roll your mouse over the Player Rating button in the Right Click menu, so the safest way to close a Right Click menu is to use the Escape key - you can still use all the other options on the menu)
If you do get the issue, you can use the following script to cleanse your execution path :
/script ReloadUI();
The above script is case sensitive, and allows you to re-load your User Interface without having to completely log out and back in again

- Duelling Blocked Action issues have not been fixed in the latest Burning Crusade Beta. But the slash command still works.
(If anyone can explain to me why the Duel function is Secure I'd be interested to hear? I've been struggling to come up with a way in which I could cheat during a battle/raid by challenging people to duels ^^)

Basically, I'm hoping that once Blizzard release a Patch, then the only permanent problem will be with Duelling from the Right Click menu - and as people can still use the Slash Commands, I'm not gonna worry about it.

Please READ the "NotesUNeed and WoW2.xx.txt" file included in the archive/zip file for NotesUNeed v5.40.20000 for any further details, clarification. (Or if you receive Unfinished String errors)