Pictures
File Info
| Compatibility: | Scions of Ithelia (9.3.0) Endless Archive (9.2.5) |
| Updated: | 04/24/24 05:31 PM |
| Created: | 01/21/24 06:53 PM |
| Monthly downloads: | 272 |
| Total downloads: | 1,007 |
| Favorites: | 5 |
| MD5: |
9.3.0
Farmers ToolKit 
A stable but still evolving AddOn, the Farmers Toolkit is a collection of command-line options and on-screen indicators to help track farming but also includes options for bounty timers, random pets, random messages in battle, when reading books, show rapport of companions, and whatever else a bored Farmer might want an AddOn to do. This is intended to be a standalone AddOn but it will use certain AddOn libraries if available (e.g., LibAddonMenu2, LibCustomMenu, etc.)
Sample capabilities:
Farming / Bag Inventory:
Bounty Countdown Timer:
Favorite Pet Support
Endeavors / Daily Gifts:
Misc stuff that a farmer totally needs for an addon (not really)
This is my first add on so a lot of things are command line for now. As I learn GUI configuration, I am updating, however. This is a stand-alone AddOn but it will make use of LibAddon and LibCustomMenu if available.
This is a collection of capabilities we in the Soloists Guild wish we had - if you have thoughts or suggestions, let me know. I am continuously developing on this in order to avoid real work and responsibilities. Also, if you have a better way to do something, please feel free to let me know - this is a learning process.
So, looking at other AddOns, this page is also where the detailed explanation seems to go so...
if that's not the case, let me know. Otherwise... .gory details below.
==========================================================
Detailed instructions / explanations / minutiae
Daily Task and Inventory Screen Example
There are three sections to this on-screen guide: (1) the daily tasks (endeavors, not daily quests) summary line, (2) the current state of inventory, and (3) a list of recommended endeavors.
(1) - The daily task line
This line summarizes how many daily endeavor (DE) and Weekly Endeavor (WE) are complete, as well as whether you have picked up your Daily Gift (DG)
The line is color coded with grey = none, yellow = at least 1 endeavor is done, green = all complete.
(2) - The inventory line
This line shows a quick summary of your open bags, e.g.,
"Farming (Open 25/205): Total 51 (Unique: 18, Restocked: 3, Chests: 2)"
Where:
- "Open 25/205" means you have 25 slots out of 205 open.
- This text will be green as long as the # of open slots > the value set for "Warning bag limit"
- The text will turn to yellow if # of open slots falls below the Warning bag limit, and a reminder ("W@25") will be shown on the line.
- The text will be red if the # of open slots falls below the panic level, and a reminder ("P@10") will be shown.
- You can set the values for warning and panic via the chat window (/ft setwarn 25) or the GUI ("Inventory Controls", if LibAddOnMenu is available - optional)
Total 51 (Unique: 18, Restocked: 3, Chests: 2) - summary of your farming so far
- This test shows that 51 total items have been farmed, of which
- 18 are unique (if you gather 15 Platinum Dust, it still only counts as one unique entry)
- 3 are restocked (meaning you did not already have some of these in your bag inventory)
- And you have looted 2 chests.
- Note: If you have any stolen items in your bags, the total count will be shown on this line as well.
Recommended endeavors
This is a list of both daily - marked with a (D) in the title - and weekly endeavors - marked with a (W)
This is not a complete list, only the ones that ESO has decided are not difficult (no "4" level entries shown)
(... because farmers will do endeavors but they can't take time away from the farm to go running off to Imperial City every day...)
Color coding / screen behavior
- The end of each endeavor line will show the progress and is color coded: grey = not started, yellow = underway.
- Once an endeavor is complete, it will be removed from the list (and the count in the summary section described above will get updated)
- Once three dailies have been completed, all the daily endeavors will be removed from the list. Similarly, once a weekly endeavor is complete, all the weekly entries will be removed.
- Once both dailies and weeklies have been completed, the list disappears entirely.... until tomorrow.
- When entering combat, this panel is replaced with encouraging words for farmers in battle (in a smaller text to free up screen space until the villain is slain...)
Chat Window Example #1
In this example of the farming reports to the chat window, you can see:
- One item of Makko being farmed for the first time (as shown by the blue text and the "Session first" bit)
This is the 5th item we've farmed this session (1 / 5) and we have a total of 2,418 in our overall inventory
- One Mundane Rune, first time seen this session (8th item overall and we have 2,549)
In addition, we're farming Mundane Runes and this is 1 of 3, with two to go
- Similarly, we farmed our first 6 pieces of Rough Ruby Ash, bringing the overall total to 58,192.
We're also farming (shopping list) Rough Ruby Ash, with a target of 44 - with this 6, we have 38 to go.
- Later on, we looted 127 gold bringing the on-character total to 2,312,716
- By 18:36, farmed another 3 pieces of Rough Ruby Ash, so the farming target shows 9/44 with 35 to go.
Note the text color for this line is yellow, visually indicating this is not the first time we've farmed it this session.
A summary of the farming report is available via /ft showtargets (I should add an image of that, I suppose)
Chat Window Example #2
Similar to the previous example but a couple of specific call outs:
- At 18:48, you see a purple line entry. The addon will celebrate your having farmed NNN number of items every time you pass NNN (set via /ft set reminder or via the GUI tool). This has no functionality other than to encourage your farming and to play a sound when you reach these interim milestones.
However, if you have the "Random Pet" option turned on (see configuration screen or set via /ft peton), there is a chance (defaults to 33% but is configurable) that a random non-combat pet will be called each time you reach a milestone.
You see an example of that in the line which reads "Suddenly, there is a rustling in your pack!".
Finally, this example also shows two additional chat-line abilities:
1 - "/ft fl" - You can list all of the items you have farmed this session using "/ft fl" (FL = farming list). It will show you the item (as a link), total number farmed (this session) and total amount in inventory.
2 - "/ft fl [search term]" - Since that list can get lengthy, you can search for matching entries using /ft fl [term] (see examples at 18:48 searching for "raw" and then "rube". This will pattern match the lines and only show the ones matching the supplied phrase.
If you've read this far, I'll tell you there is also a "/ft fl2" command which displays the unique id # of the item as well. Not that you need that but farmers are just a curious lot by nature.
Farming / Shopping List Window Example
(Note: This snapshot was taken at a different time so it won't flow with the numbers from the previous examples)
In this example, we have 1 of 15 Alchemical Resins, none of our Butterfly Wings, and 12/ 50 (24%) of our Rubedite Ore target amount.
Once a target has been met, it is removed from the on-screen list (but still shows in the chat window via "/ft showtargets")
Optional Functionality
If the LibCustomMenu library is available, you can set targets for items in your inventory by right clicking the item and choosing "Set Farming target via chat". This will simply key in the command line argument of "/ft settarget [link] " and then let you type in a number and hit ENTER to set / update the target count for that item.
If the LibAddonMenu library is available, you can configure settings via the GUI (Settings ->Addon->Farmers Toolkit) (see examples, below). There are command line equivalents for all the configurable items (except for changing fonts. On the list to add, I just need to find a nicer way of entering font names via text.)
Reporting Controls
In this example, you can control the fonts for the lines and lists detailed above as well as control whether they are active:
- Chat reporting will turn on/off the farming reports sent to chat (i.e., the examples above)
- Screen reporting will turn on/off the daily / inventory on-screen reports
- Farming target will turn on/off the farming list shopping list on-screen reports.
- Not shown, there are also entries for choosing favorite pets (As of update 240219g)
Inventory / Miscellaneous Controls
You can set the Warning and Panic levels for # of open slots in your bags (either by using the slider or just typing in a number and hitting ENTER)
You can also turn on/off the random pet swapping upon reaching a milestone (# of items farmed)
You can set the milestone limit (the reminder count, reminding you what a great job you are doing with this farming stuff) via "/ft reminder NNN"
And, to be honest, sometimes, you just can't wait for the milestone and you want a random pet. Thus, the "Gimme a random pet" button (or "/ft petnow" chat command)
Generally speaking, most everything is written to be chat-line friendly and not require any additional libraries. With that in mind, here is a snap shot to the current list of chat commands. This list will change and if it grows much more, a screenshot really won't work so going forward, for the latest updates, check back here or use the "/ft news" command after an update. With the exception of setting fonts, everything available in the GUI can be done at the command line.
Sample Help Line
There are entries in this list that aren't discussed above (/ft savedata/loaddata, /dt savetargets/loadtargets, etc.) but the help screen should get you through the bulk of that kind of thing.
Finally, putting it all together, it can look something like this. (Remember, you can change the fonts/sizes and toggle the panels)...
If something doesn't make sense (likely) or I've missed some functionality you really need (very likely), drop me a line. If I can figure out how to do it (iffy likely), I will!
-V
Sample capabilities:
Farming / Bag Inventory:
- Show quantity of items just farmed (how many you just got, how many you have overall)
- Added ability to have "shopping lists" aka farming targets on screen (track / find NN of [item])
- Color-coded, on-screen status of bags (open slots, adjustable levels for "warning" and "panic" messages)
- Search through recently farmed (i.e., this login session) items and get count (this session and overall)
- List items farmed and which bank they are currently in (backpack, bank, craft bag, etc.)
- General stats (%age of "new" items, # of chests opened, etc.)
- On-screen summary of open slots, # of items farmed, # of slots used by treasures/trash/containers, etc.
Bounty Countdown Timer:
- Show the amount of time left before your bounty drops to zero
- Updates on screen every 15 seconds
- Only shows while bounty is active (but also shows while in restricted areas, houses, etc.)
Favorite Pet Support
- You can now identify a subset of your pets to be "favorites" and randomly launch one via "/ft petnow" (or via a button in the GUI)
- If you have marked pets as favorites and turned on "PetSwap" (see below), it will draw only from the list of favorite pets (otherwise, it will randomly pull from any of your available non-combat pets).
Endeavors / Daily Gifts:
- Track which daily and weekly endeavors you are working on, show on-screen reminders until complete
- Track whether you have received the latest daily gift, show # complete, # to go, etc.
- Flash an on-screen reminder if you have unfinished endeavors within 3 hours of the reset time.
Misc stuff that a farmer totally needs for an addon (not really)
- Flash an onscreen reminder if daily/weekly endeavors are about to time out (3 hour warning)
- On-screen bounty timer (in test)
- Randomly choose a non-combat pet after farming NNN items (NNN is configurable)
- Play a celebration sound when certain items are farmed (butterfly wind and mudcrab chitin, for now, you can add to the list via "/ft set targets" or via the GUI (right click an item in inventory)
- Show companion's rapport levels (the original function of this addon...)
- Unrelated commentary on-screen when reading books, doing battle, etc. (Farmers: Time rich, sometimes)
This is my first add on so a lot of things are command line for now. As I learn GUI configuration, I am updating, however. This is a stand-alone AddOn but it will make use of LibAddon and LibCustomMenu if available.
This is a collection of capabilities we in the Soloists Guild wish we had - if you have thoughts or suggestions, let me know. I am continuously developing on this in order to avoid real work and responsibilities. Also, if you have a better way to do something, please feel free to let me know - this is a learning process.
So, looking at other AddOns, this page is also where the detailed explanation seems to go so...
if that's not the case, let me know. Otherwise... .gory details below.
==========================================================
Detailed instructions / explanations / minutiae
Daily Task and Inventory Screen Example
There are three sections to this on-screen guide: (1) the daily tasks (endeavors, not daily quests) summary line, (2) the current state of inventory, and (3) a list of recommended endeavors.
(1) - The daily task line
This line summarizes how many daily endeavor (DE) and Weekly Endeavor (WE) are complete, as well as whether you have picked up your Daily Gift (DG)
The line is color coded with grey = none, yellow = at least 1 endeavor is done, green = all complete.
(2) - The inventory line
This line shows a quick summary of your open bags, e.g.,
"Farming (Open 25/205): Total 51 (Unique: 18, Restocked: 3, Chests: 2)"
Where:
- "Open 25/205" means you have 25 slots out of 205 open.
- This text will be green as long as the # of open slots > the value set for "Warning bag limit"
- The text will turn to yellow if # of open slots falls below the Warning bag limit, and a reminder ("W@25") will be shown on the line.
- The text will be red if the # of open slots falls below the panic level, and a reminder ("P@10") will be shown.
- You can set the values for warning and panic via the chat window (/ft setwarn 25) or the GUI ("Inventory Controls", if LibAddOnMenu is available - optional)
Total 51 (Unique: 18, Restocked: 3, Chests: 2) - summary of your farming so far
- This test shows that 51 total items have been farmed, of which
- 18 are unique (if you gather 15 Platinum Dust, it still only counts as one unique entry)
- 3 are restocked (meaning you did not already have some of these in your bag inventory)
- And you have looted 2 chests.
- Note: If you have any stolen items in your bags, the total count will be shown on this line as well.
Recommended endeavors
This is a list of both daily - marked with a (D) in the title - and weekly endeavors - marked with a (W)
This is not a complete list, only the ones that ESO has decided are not difficult (no "4" level entries shown)
(... because farmers will do endeavors but they can't take time away from the farm to go running off to Imperial City every day...)
Color coding / screen behavior
- The end of each endeavor line will show the progress and is color coded: grey = not started, yellow = underway.
- Once an endeavor is complete, it will be removed from the list (and the count in the summary section described above will get updated)
- Once three dailies have been completed, all the daily endeavors will be removed from the list. Similarly, once a weekly endeavor is complete, all the weekly entries will be removed.
- Once both dailies and weeklies have been completed, the list disappears entirely.... until tomorrow.
- When entering combat, this panel is replaced with encouraging words for farmers in battle (in a smaller text to free up screen space until the villain is slain...)
Chat Window Example #1
In this example of the farming reports to the chat window, you can see:
- One item of Makko being farmed for the first time (as shown by the blue text and the "Session first" bit)
This is the 5th item we've farmed this session (1 / 5) and we have a total of 2,418 in our overall inventory
- One Mundane Rune, first time seen this session (8th item overall and we have 2,549)
In addition, we're farming Mundane Runes and this is 1 of 3, with two to go
- Similarly, we farmed our first 6 pieces of Rough Ruby Ash, bringing the overall total to 58,192.
We're also farming (shopping list) Rough Ruby Ash, with a target of 44 - with this 6, we have 38 to go.
- Later on, we looted 127 gold bringing the on-character total to 2,312,716
- By 18:36, farmed another 3 pieces of Rough Ruby Ash, so the farming target shows 9/44 with 35 to go.
Note the text color for this line is yellow, visually indicating this is not the first time we've farmed it this session.
A summary of the farming report is available via /ft showtargets (I should add an image of that, I suppose)
Chat Window Example #2
Similar to the previous example but a couple of specific call outs:
- At 18:48, you see a purple line entry. The addon will celebrate your having farmed NNN number of items every time you pass NNN (set via /ft set reminder or via the GUI tool). This has no functionality other than to encourage your farming and to play a sound when you reach these interim milestones.
However, if you have the "Random Pet" option turned on (see configuration screen or set via /ft peton), there is a chance (defaults to 33% but is configurable) that a random non-combat pet will be called each time you reach a milestone.
You see an example of that in the line which reads "Suddenly, there is a rustling in your pack!".
Finally, this example also shows two additional chat-line abilities:
1 - "/ft fl" - You can list all of the items you have farmed this session using "/ft fl" (FL = farming list). It will show you the item (as a link), total number farmed (this session) and total amount in inventory.
2 - "/ft fl [search term]" - Since that list can get lengthy, you can search for matching entries using /ft fl [term] (see examples at 18:48 searching for "raw" and then "rube". This will pattern match the lines and only show the ones matching the supplied phrase.
If you've read this far, I'll tell you there is also a "/ft fl2" command which displays the unique id # of the item as well. Not that you need that but farmers are just a curious lot by nature.
Farming / Shopping List Window Example
(Note: This snapshot was taken at a different time so it won't flow with the numbers from the previous examples)
In this example, we have 1 of 15 Alchemical Resins, none of our Butterfly Wings, and 12/ 50 (24%) of our Rubedite Ore target amount.
Once a target has been met, it is removed from the on-screen list (but still shows in the chat window via "/ft showtargets")
Optional Functionality
If the LibCustomMenu library is available, you can set targets for items in your inventory by right clicking the item and choosing "Set Farming target via chat". This will simply key in the command line argument of "/ft settarget [link] " and then let you type in a number and hit ENTER to set / update the target count for that item.
If the LibAddonMenu library is available, you can configure settings via the GUI (Settings ->Addon->Farmers Toolkit) (see examples, below). There are command line equivalents for all the configurable items (except for changing fonts. On the list to add, I just need to find a nicer way of entering font names via text.)
Reporting Controls
In this example, you can control the fonts for the lines and lists detailed above as well as control whether they are active:
- Chat reporting will turn on/off the farming reports sent to chat (i.e., the examples above)
- Screen reporting will turn on/off the daily / inventory on-screen reports
- Farming target will turn on/off the farming list shopping list on-screen reports.
- Not shown, there are also entries for choosing favorite pets (As of update 240219g)
Inventory / Miscellaneous Controls
You can set the Warning and Panic levels for # of open slots in your bags (either by using the slider or just typing in a number and hitting ENTER)
You can also turn on/off the random pet swapping upon reaching a milestone (# of items farmed)
You can set the milestone limit (the reminder count, reminding you what a great job you are doing with this farming stuff) via "/ft reminder NNN"
And, to be honest, sometimes, you just can't wait for the milestone and you want a random pet. Thus, the "Gimme a random pet" button (or "/ft petnow" chat command)
Generally speaking, most everything is written to be chat-line friendly and not require any additional libraries. With that in mind, here is a snap shot to the current list of chat commands. This list will change and if it grows much more, a screenshot really won't work so going forward, for the latest updates, check back here or use the "/ft news" command after an update. With the exception of setting fonts, everything available in the GUI can be done at the command line.
Sample Help Line
There are entries in this list that aren't discussed above (/ft savedata/loaddata, /dt savetargets/loadtargets, etc.) but the help screen should get you through the bulk of that kind of thing.
Finally, putting it all together, it can look something like this. (Remember, you can change the fonts/sizes and toggle the panels)...
If something doesn't make sense (likely) or I've missed some functionality you really need (very likely), drop me a line. If I can figure out how to do it (iffy likely), I will!
-V
Optional Files (0)
Archived Files (6)
File Name |
Version |
Size |
Uploader |
Date |
240329i |
54kB |
Vilkasmanga |
03/29/24 02:57 PM |
|
240229h |
51kB |
Vilkasmanga |
02/29/24 02:35 PM |
|
240219g |
46kB |
Vilkasmanga |
02/19/24 01:43 AM |
|
240219g |
38kB |
Vilkasmanga |
02/07/24 11:56 PM |
|
240130d |
29kB |
Vilkasmanga |
02/01/24 04:44 PM |
|
240129b |
25kB |
Vilkasmanga |
01/29/24 01:05 AM |
 |
Comment Options |
02/13/24, 05:59 PM
|
|
 Forum posts: 7
File comments: 12
Uploads: 1
|
Re: Re: bug on lockpick success ?
Last edited by Vilkasmanga : 04/25/24 at 05:47 AM.
|
|
|
|
02/12/24, 08:05 PM
|
|
|
Forum posts: 7
File comments: 12
Uploads: 1
|
Re: bug on lockpick success ?
|
|
|
|
|
02/11/24, 12:37 PM
|
|
|
Forum posts: 0
File comments: 4
Uploads: 0
|
Re: bug on lockpick success ?
|
|
|
|
|
02/11/24, 12:25 PM
|
|
|
Forum posts: 0
File comments: 4
Uploads: 0
|
bug on lockpick success ?
|
|
|
|
|
02/08/24, 07:28 PM
|
|||
|
Forum posts: 7
File comments: 12
Uploads: 1
|
|
||
|
|
|
|
02/08/24, 11:48 AM
|
||
|
Forum posts: 7
File comments: 12
Uploads: 1
|
 |
|
|
|
|
|
02/08/24, 03:32 AM
|
|
|
Addon Addict
 Forum posts: 211
File comments: 869
Uploads: 0
|
Patiently waiting for some screenshots to show the addon in action.
 |
|
|
|
|
02/01/24, 04:47 PM
|
|||||||
|
Forum posts: 7
File comments: 12
Uploads: 1
|
Re: Re: Re: Re: Re: Re: Leaking globals no more
|
||||||
|
|
|
|
01/30/24, 08:38 AM
|
||||||
|
Forum posts: 7
File comments: 12
Uploads: 1
|
Re: Re: Re: Re: Re: Leaking globals no more
-V |
|||||
|
|
|
|
01/29/24, 10:49 PM
|
|||||
|
Forum posts: 409
File comments: 892
Uploads: 21
|
Re: Re: Re: Re: Leaking globals no more
From what I can see with a quick check, you did seem to get everything. Thanks for making the changes! Few notes: local FarmersToolkit = {} -> This actually doesn't need to be local, as the addon table is an exception to the 'don't make globals' rule. There's nothing wrong with it being local; but if you split up the addon into multiple files, then this should be global. That will allow you to 'communicate' between different files. I actually do highly suggest splitting up the addon into multiple more modular files. It makes it a lot easier to navigate files, especially when they start getting very large. You kind of noticed it was weird already But you don't need local DailyClaimed = "N" at line 400. (or line 1906) You're only using a 'DailyClaimed' in another function, where it is separately initialized and declared as local, and thus different from the other two DailyClaimed. So the local variable created on those two lines are never actually used anywhere.Code:
local exampleVar = 1
local function exampleFun()
local exampleVar = 2
d(exampleVar) -> outputs 2, the exampleVar outside of the function is hidden
end
local function exampleFun2(exampleVar)
d(exampleVar) -> outputs whatever is passed to the function as a parameter,
the exampleVar outside of the function is hidden here too
end
d(exampleVar) -> outputs 1, the exampleVar inside of the function does not exist outside of the function
Last edited by Dolgubon : 01/29/24 at 10:51 PM.
|
||||
|
|
|
|
01/29/24, 11:17 AM
|
|
|
Forum posts: 7
File comments: 12
Uploads: 1
|
Re: Re: Re: Leaking globals galore
|
|
|
|
|
01/23/24, 09:45 PM
|
|
|
Forum posts: 409
File comments: 892
Uploads: 21
|
Re: Re: Leaking globals galore
|
|
|
|
|
01/23/24, 09:44 PM
|
||
|
Forum posts: 7
File comments: 12
Uploads: 1
|
Baertram - Thanks for your feedback and suggestions- these look like great references. I'll review these links as well as Dolgubon's email and take another swing at it. It is probably easiest if I pull the (misnamed/typo'd) submission down in the meantime, yes?
-V
|
|
|
|
|
|
01/23/24, 09:38 PM
|
|
|
Forum posts: 7
File comments: 12
Uploads: 1
|
Re: Leaking globals galore
|
|
|
|
|
01/22/24, 01:34 AM
|
|
|
Super Moderator
 Forum posts: 4989
File comments: 6040
Uploads: 78
|
Hi and welcome to ESO addon development.
As Dolgubon already said please make variables local where global ones are not needed. Please read this e.g. about lua https://www.esoui.com/forums/forumdisplay.php?f=172  ->  and this about new ESO addons https://www.esoui.com/forums/forumdisplay.php?f=170 
Last edited by Baertram : 01/22/24 at 09:00 AM.
|
|
|
|
|
