Checklist2
<BODY>
A new version of Checklist, now called Torta, is being worked on for WotLK. You can download it from either here or here.
Description
Checklist2 is a simple addon that allows you to list the things that one must keep track on. It is intended to provide the functionality that its name suggests - a checklist. Some uses are:
- Keeping track of things to do for a levelling guide
- Crafting lists for your alts
- A list of dailies you have to do
- Items you're aiming towards
- Things that members of your group or raid need in a specific dungeon
As of now, the FuBar plugin will display all unchecked tasks on mouseover. It also displays the amount of completed tasks over the total amount of tasks, and the percentage of tasks completed. This will receive further refinements as ideas and suggestions come to me.
One useful new feature that got added in 2.0 is the ability to create arbitrary amounts of lists and list items. Simply right-click on the tasks indicator to change how many tasks the current list has, or right click an existing list in the menu and select "New" to create a new list. Easy, huh?
Checklist2 has been uploaded to the Ace SVN - you can download it from http://files.wowace.com/ or use the WowAceUpdater, if you have it. The copy there will be updated more often, so you'll get new features and additions possibly within hours of them being written. The downside? Bugs may slip through, though I always test the critical functions before uploading anywhere.
One major feature currently being worked on is list sharing. This is intended to be used for party and raid purposes, to keep track of who wants/needs what. Let's say Bob needs Item X from Boss Y, Joe needs Item Y from Boss X, and Bill needs Item Z from boss Z. This aims to help prevent situations where party/raid members would feel neglected, and can help a group's efficiency. Less of "What does he need from here again?", which can only be a good thing.
Currently, the feature to reskin the Checklist2 window has been removed. This may or may not be reimplemented. I'm looking at creating a custom texture for Checklist that will make it truly fit into the WoW UI.
To summarize, Checklist is an addon made by forgetful people (me XD), for forgetful people. I intend it to be used for things that would require the same procedures and must not be forgotten. A perfect example of this is this AddOn itself! I myself use Checklist to keep track of suggestions, and pre-release tasks. Another is for taking down stuff you need made by an alt. For example, my main is a leatherworker. My alt is a rogue. I list the stats of my alt's gear on Checklist2, then send usable gear upgrades back. Back then, I'd relog back and forth... (no pen and paper near my PC)
Slash Commands
Slash commands are /checklist2, or /cl2 for short. Below is a brief description of what each slash command does.
- /cl2 check taskNumber - Checks the specified task number
- /cl2 deletelist listName - Pops a confirmation dialog to delete the specified list
- /cl2 newlist listName - Creates a new list with listName as its name.
- /cl2 renamelist oldName, newName - Takes list oldName and renames it to newName. The string is split at ", ". Case sensitive - names must be *exact*.
- /cl2 reset - resets the position of all Checklist windows.
- /cl2 setlist listName - Sets the list to display
- /cl2 ui - Toggles the Checklist window
- /cl2 uncheck taskNumber - Unchecks the specified task
As a side note, Checklist2 and any version of Checklist 1 are stored in separate folders and will act as two different AddOns. I made sure that there will be no conflicts between the two major versions. One side effect is that the two are unable to understand each other's data - older versions don't expect more than five lists, while the new DB system can handle arbitrary amounts of data. Keep an eye on releases at WoWAce for the latest features, fixes, and optimizations.
Special thanks to Magictrix of Hakkar for the idea, and Abraxxis of Draenor, Heretical of Ysera, Akalabeth of Ner'zhul and Xaxziminraxb of Twisting Nether for suggestions.
Legend: <font color="green">Completed and awaiting release</font> | <font color="blue">Working on it</font> | <font color="red">On the horizon</font>
In the works for Checklist2
These are currently being worked on and will soon be added to Checklist.
- <font color="blue">Port to Ace3. Performance stats coming soon...</font>
- <font color="blue">A notepad. Partly because I don't like MS Notepad too much XD</font>
Suggested suggestions
(Hey, I didn't make this addon to invent good addon page section titles...)
- <font color="blue">List synchronization</font>
- <font color="blue">Task timers</font>
Also, see posts below for other proposed features.
(After FuBar plugin is polished)
- <font color="red">Titan plugin</font>
Original suggestions thread can be found here.
Known Bugs
As it's somewhat time consuming to update bug lists on two different sites using completely different formatting, I've moved this section to a subpage of my author portal on WoWInterface. See here.
Fun thing I discovered with my own AddOn:
1. Create a list. Don't do this with something you need because you're gonna delete it later.
2. Type the following. CTRL+C to copy, CTRL+V to paste into WoW.
/run for i = 1, 1320 do Checklist2:CreateListItem(true); end; Checklist2:ListItemSBUpdate()
3. You should now have exactly 1337 list items if you got the Alicia's Poem list, and 1336 if you got the welcome message. If you got the latter, click "More List Items" once.
4. Scroll down and confirm that you do have 1337 list items.
The script above takes about .25 seconds to run but it shouldn't lock your UI. If you're using beta 1 or beta 2, update before trying this out - it may lock your UI if you don't.
Once you're done "testing" this out, delete the list and reload your UI. Having this much list items takes roughly 250 KiB of RAM.
Note: If Checklist2 glitches while doing this, post what exactly happened and the error message(s) (if any)
Checklist 2.0 Beta released!
Woot!
*Faints from exhaustion*
Now the fun part: List sharing
Hmm, development has hit a small bump in the road.
Well, depending on what your definition of "small" is.
The core code for the "applet" has been written, and it was supposed to be released on the first weekend of January. I've successfully managed to find a way to create an unlimited amount of lists. The problem was, it was very difficult to delete it once it was created. :(
From that, I went on reshaping the structure of the database. It was messy. Very messy. Now I've found that a majority of the code right now had to be revamped. And so I made the decision - the next version will be a 2.0 release, rewritten from scratch. I'll try my best to include as much of the suggestions as possible, especially the "shared lists" suggestion on WoWI, which has seen quite a few requests on the UI & Macros forum in the past. I'll also use as much development help tools as I can get my hands on to speed this up.
Should there be huge bugs in the current release (v1.2.74.0322) I'll make fixes. Report them, if any.
Wish me luck! >.<
ANNOUNCEMENT
This is probably the first time I'm gonna use a serious tone in an entire post.
Hi all. Thank you for using my AddOn. Just 5 minutes ago I did a Google search for Checklist with the keywords:
checklist "world of warcraft" (mod OR addon)
(OR is a conditional. Quite useful in Google)
I expected this page to come up at the top. Instead, another link showed up! This AddOn has been posted on www.fileradar.net with neither my knowledge nor my consent!
Please take note: I am not responsible for any possible trojans and viruses that you may get from this mod if you download it from an unsupported site. As of this post, I've only uploaded on Curse and WoWInterface.
If you uploaded this on some other site, please remove it from there or add a link to either here or tp Checklist's WoWInterface page on it's description, plus a disclaimer that you did not author the AddOn.
Thank you for reading.
-Quez
Woah!
Thanks for taking the time to suggest all that! :D
My answers:
1) The Add and Delete from the main UI parts are part of my to-do-list for Checklist. I'm gonna make the list item text and the area around it clickable for the second part (Deleting)
2) Same as above. I suppose the clicked list item would open a dropdown box containing the options to deleting and editing. Automatically filling up the editbox if there's a note - simple, really. Checklist actually clears the editbox when it is shown. I'll put in an option for that.
3) I honestly didn't manage to think of that. Simple but brilliant!
4) Luckily my current API can handle that :)
5) Added to my Suggestions list. I use Checklist too!
6)(I actually had to look up what 'drop shadow' meant for this answer...)
Will replace with a more "normal" font. As for font size, overly enlarging the font will make it look strange, I heard, but that should be possible.
7)The option to get 16 has been a very strange anomaly since the day I coded it. The logic is bugging out for some reason. I'm already working on it.
8) It is possible to have an infinite amount of lists and checks. The question that popped up in my mind, though, was "Do people need that many?". Well, now I know the answer is "yes". The reason I hesitated was to prevent bloating Checklist. I don't want my li'l baby (lol) getting called a memory hog. I'll do that :)
Another thing: If you manually create a list and access it using /run scripts from the chat box, in theory it would work, though that'd take a lot of /run scripts...
9) That could be placed where the Set buttons are now :D
10) For that to be really practical I think I'm just gonna remove the number, since it's "fused" with the note. Other than that, should be fine.
11) RL obligations prevented me from really getting into this, though since Christmas is coming, it'll be in before the end of the year.
12) Candy corns look good! :P
Those were fascinating questions, and I look forward to hearing everyone's feedback when these are completed.
Okay, time for an update.
I've finally fixed that More Checks bug (WOOT!). Apparently it was caused by code executing in an incorrect order. Now to fix that minimap issue, then I can get to those feature suggestions...
EDIT: I've found a fix to the minimap button issue at last! Time to get on those features...
First up, the "applet". I *might* release a new version after I finish that up and enable the creation of an infinite number of lists/checks.
I got tired of writing down all my WoW "to-do" lists on paper so I started looking for a specific addon that would facilitate that sort of thing in-game instead, and then I came across this one. True, I could just use a notepad type addon, but I'd prefer one that actually has the additional functionality that a task list offers.
Checklist is a nice addon with great potential, but it needs some work still. Here's some suggestions...
1) Allow a way to Add and Delete tasks directly from the main UI (rather than needing to go to the options). It would be nice if any individual task could be deleted (not just from the last note back). Perhaps a button at the bottom to add a task and a button beside each task to remove it (or a right-click context menu on the task items), or just allow a task to be selected and then have a delete button at the bottom to remove the selected task.
2) Remove the "Set" button(s). Instead make clicking (double-clicking?) a task's note allow you to edit it right there (or pop up the text edit dialog). Either way, if a note already exists for a task then always make that text appear in the dialog when editing and just automatically select it all for the user, that way they can either easily delete it or add on to it.
3) Provide an up and down arrow for shifting tasks up and down on the list, so a task can be selected and then moved around where it is on the list (think about the list that Wardrobe or Outfitter uses for outfits and how you can move around the order where they show up on the list).
After using Checklist for a little I found this feature to be very desired.
4) Remove the tip text from the Minimap Icon's tooltip. Most people know that left-clicking brings up the menu/main UI on a button and right-clicking brings up options. Also, it would be very handy if the menu for the Icon shows all your checklists and their current status, allowing you to click on any of them to bring up that checklist directly in the main UI.
5) The option to show/hide checked off items should be right in the main UI as well, to easily make completed tasks visible if desired.
6) Either remove or provide an option to get rid of the drop-shadowing on the text used for tasks, it makes it very hard to read the tasks in most colours. In fact, some font options would be nice (such as size of font, drop-shadow, etc).
7) Allow adding more than 15 items to list (even the 16th item won't show currently). I'd prefer an unlimited amount of items (with a scroll bar), but I don't know what kind of restrictions there are on something like that. If it can't be done then at least cut the list off at 15 so adding a 16th item doesn't cause the rest of the list to "disappear".
8) I think the main UI would function better without radio buttons for the checklists. Instead provide a listbox to the left of the main UI that contains all the checklists, that way it's cleaner and a person could feasibly have unlimited amounts of checklists (if possible).
Selecting a checklist in the list box would automatically make that checklist show in the main UI. The checklists in the list box should even show their current complete/total status, for convenience. There should be buttons in this checklist "applet" that let you add new checklists and delete the currently selected one. A button in the main UI to show/hide this applet would be the icing on the cake, to save screen space.
9) Prioritizing flags for tasks would be nice too, to indicate how important tasks are to complete.
10) Sorting options would be really nice for checklists too, such as by complete/incomplete, number, priority, and task note.
11) If you really wanted to get fancy, then using a dialog when adding tasks would be really cool. Where you could enter the task note and set a priority. Even neater would be some kind of timer system for tasks, such as being able to set a day/time when a task should automatically check/delete itself or raise its priority, or set a day/time when a task should be re-occur on a list after checked completed.
12) Finally, what the heck is up with the icon? Why not use something like, I don't know, a checkmark? :P
Update!
After taking a 'short' break, I'm back and working on this again. I've finally gotten a functional check counter (displays number of checks checked over number of checks being used on the FuBar plugin).
Key binding to show Checklist done.
Checklist frame made movable - Will take ~10 lines of code, will be done this afternoon. Will have a hotkey-toggle option. (Done!)
Checking items would change color - will dig through WoWWiki on how to do that :) (Done!)
Releasing on Saturday/Sunday. Patch is on Tuesday, Nov. 9.
Hearing this is like hearing that Firefly has 5 lost episodes that will be released on collector's edition DVD to the masses. This is my favorite addon to watch the development of, since i've been using it from the start, and it just keeps getting better.
@menace97: Those sound doable, I'll add them to the "Suggested suggestions" section.
@ZwizzeR: That's something I'm considering, but there's far less documentation on Titan so plugin creation may not be as easy as when I dived into FuBar :(
Great idea for an addon! I too need lists/notes to keep me on-track. This could be very helpful.
Suggestions:
Thanks.
dont suppose u could make a Titan bar plugin aswell?
A version with a decent FuBar plugin has been uploaded. Release was delayed due to a minor error which made Checklist behave improperly.
On the bright side, things should run two to fifteen times faster now :D
The FuBar plugin is almost done, I just need to fix a little math issue...
Edit: Uploaded a new beta version with updated TOC number. The plugin for FuBar is mostly functional now, all that needs to be fixed is the buggy incomplete tasks counter :)
Wonderful news! Been using since the start. Stick with it! And I'll keep using it.
~XaxziminraxB
2.2 is probably gonna release on Tuesday, so I'm working on the update as fast as I can. It'll have FuBar support and will display unfinished tasks on mouseover (hopefully :S)
And yes, I forgot to change the TOC number on the beta version. :(
That's actually why I switched to Fubar :) the words "well documented API" sound like great music to me...
(used to be a titan guy but that thing takes 5 seconds to load in high-stress situations. Fubar ftw!)
I'll start working on that soon. First I gotta hit 70, just 1 and a half levels away :D
I vote for fubar support too.
Awsome mod man. You may want to consider adding fubar support. It would make it even sweeter! keep it up!