Download
(30 Kb)
Download
Updated: 10/31/23 10:40 PM
Pictures
File Info
Compatibility:
Endless Archive (9.2.5)
base-game patch (9.1.5)
Necrom (9.0.0)
Updated:10/31/23 10:40 PM
Created:04/10/14 02:17 AM
Monthly downloads:1,370
Total downloads:196,934
Favorites:341
MD5:
Categories:Miscellaneous, Character Advancement, RolePlay, Utility Mods
9.2.5
Librarian Book Manager  Popular! (More than 5000 hits)
Version: 3.11
by: Flamage, Orionik
Librarian records every book your character reads in-game and keeps a list of when it was found and whether you have marked it as read, allowing you to continue questing (and not hold up other players) while being confident you won't forget to read anything later.

Any suggestions, bugs or general discussion about the addon can be posted in the comments tab above, in my author portal (button on the right) or in this forum thread.

Features:
- Ability to mark books as read / unread. Books are marked as unread initially so you can feel free to skip reading while questing and know that your book will be easily found later.
- When reading a book, an is shown for books not marked as read (can be disabled in the settings)
- Displays the books in the default book reader interface.
- Imports books you have already read from the Lore Library / Eidetic Memory.
- Records the time each book was first discovered.
- Optionally view books found on your other characters.
- Sorting by unread / read status, time discovered, book title and word count.
- Full text search of all the books in your collection.
- Displays a count of the total number of books found so far and the number that are unread.
- Key binding to open the Librarian window (and a bonus keybind for /reloadUI).
- Optional reminder to /reloadui (and force a save of Librarian data) when a certain number of new books have been discovered, to help prevent loss of data if the client crashes.
- Add some icons in "Lore Library" to see which books are read and which aren't and add possibility to mark them as read/unread there (can be disabled in the settings)

How to use:
- Bind a key for Librarian in the Controls, Keybinds settings menu, or type /librarian into the chat window to open Librarian.
- Click a book or press the action button ('E' by default) while hovering over a title to read that book.
- Hover over a title and press the secondary action button ('R' by default) to toggle the unread state of the highlighted book. You can also toggle the unread state of a book while reading it.
- Click on the column headers to sort by that field. Click again to sort in descending order.

SavedVariables warning:
Librarian relies on SavedVariables to store information about the books you have found. If this file is lost or corrupted, that information will be lost. Therefore, it is important to backup your saved variables regularly. This is quite simple:
1 - Go to your SavedVariables folder (on windows, this can be found at MyDocuments\Elder Scrolls Online\live\SavedVariables.
2 - Create a folder called Backup.
3 - Select Librarian.lua and right click, select copy.
4 - Open the Backup folder, and paste the file.

With version 3, the save was entirely adapted to fix some issues and allow to reduce its size but it is better to copy it elsewhere before updating the addon in order to easily rollback in case of a problem.

Although, if you encounter an issue and didn't copied your save before the update, you can rollback your save by editing your save file (MyDocuments\Elder Scrolls Online\live\SavedVariables\Librarian.lua) and replacing the sections "characterBooks" and "books" of the "Librarian_SavedVariables" table with the content of "LibrarianDeprecation_SavedVariables_Backup" which is in LibrarianDeprecation.lua (next to Librarian.lua). Then you can, install back the previous version of the addon.

Dependency:
- LibAddonMenu-2.0

Starting from v3.5, Librarian is able to display books added by "The Librarium" add-on. If you want more books and see what the ESO community can produce, you should check it out. Big thanks to Alianym for making this collaboration possible.
3.11 2023-11-01
- Updated API for Secret of the Telvanni (101040)

3.10 2023-08-23
- Updated API for 2023 update of quality of life (101039)

3.9 2023-06-05
- Updated API for Necrom (101038)
- Fix book reader scene is now "loreReaderDefault" instead of "loreReaderInteraction"
- Add back PlaySound when opening the reader (but it seems the bug is coming from eso as there is no sound when opening a book from the lore library since the update)

3.8 2022-11-02
- Updated API for Scribes of Fate (101037)

3.7 2022-11-13
- Add chinese translation, credit goes to KomeSake who posted it in the comment section of Librarian in esoui.com

3.6 2022-11-02
- Updated API for Firesong (101036)

3.5 2022-10-03
- Add API for external addon to be able to register their own books to Librarian

3.4 2022-09-11
- Add keybind in lore reader only when the book is recognized by Librarian (it avoids conflicting with other addon like TheLibrarium)
- Add possibility to delete books which don't have a category

3.3 2022-08-23
- Updated API for Lost Depths (101035)
- Widden "Found" column for 12Hour format

3.2 2022-08-06
- Create separate lib for deprecation in order to make eso create a second file for the save variables.

3.1 2022-08-02
- Improve deprecation
- Prevent from opening a book that the current character doesn't know

3.0 2022-07-25
- Updated API for High Isle (101034)
- Fix issues
- Add icons in lore library
- Add option to mark book as read directly from lore library
- Remove Import from before patch option which was meant for save created back in 2015
- Remove some deprecation code for save before 2015
- Deprecate global saves to use bookId as identifiers instead of the title (several books had the same name) and remove all data that could be retrieved thanks to ESO API now that we have the bookId (title, body, medium, showTitle, wordCount). It lightens the save (~2MB for all the books on one character) and allow the player to switch language (although a few books can't be retrieved with their bookId because they don't have a category/collection so for them all the data are kept). Keep for now the previous save in a separate table in case there is a mistake in order to be able to roll back)
- Deprecate characterBooks save, it now references the bookId instead of the title and fill at the same time the unreadPerCollection list
- Optimize ImportFromLoreLibrary by removing the Refresh every frame (without it, past 1000 books, the game slow down a lot and at 4000 you end up with less than 1fps)
- Activate back auto importation from init now that it is quick enough
- Add full localization and support for french language
- Add a small timer before refreshing the list when doing a research as we could trigger a crash if we were typing a search too fast when we have too many books
- Improve settings (better integration with LibAddonMenu and add a few options)
- Add category column in Librarian UI
- Use smaller font in order to fit all of the text in the UI
- Add button to select if you want to search through the Full-Text or just the Title of the books

2.0 (2/12/18)
- Updated API for Dragon Bones (100022)
- Fixed issue with ZOS function LoreReader, and new issue with ZO_SceneManager. Currently closes back to
UI and not Librarian list, will update that soon.

1.9 (9/10/17)
- Updated API for Horns Of The Reach (100020)
- Updated LAM to 2.0 r24
- Fixed issue with ZOS function LoreReader

1.8 (6/10/17)
- Updated API for Morrowind (100019)

1.7 (2/5/17)
- Updated LAM to 2.0 r23
- Updated to API 18 (Homestead)

1.6.3 2016-09-10
- Import feature working much better thanks some input from Votan (Thank You!)

1.6.2 2016-09-10
- Updated to LibAddonMenu 2.0 r17
- Updated for Shadows of the Hist, API 100016, also confirmed working for 100017
TODO: Looking at building language localizations and some category filters for book types. Also looking at improving the import function.

1.6.1
- Added License for LibAddonMenu

1.6.0
- Updated TOC for Tamriel Unlimited
- Updated LibAddonMenu

1.5.0
- Updated TOC for patch 1.5
- Updated LibAddonMenu 2.0

1.4.0
- Updated TOC for patch 1.4

1.2.6 2014-9-5
- Added an option to disable the character spin when opening the Librarian window.
- Added a shortcut button to the setting window in the top right of Librarian.
- Compatibility fixes for version 1.4 from the PTS.

1.2.5 2014-8-18
- Exiting the book reader interface now returns to Librarian rather than the base scene. Also fixes this behaviour with books opened from the inventory and the lore library.

1.2.4 2014-8-15
- Modified the SavedVariable import process to fix data for all accounts, not just the currently logged-in account.

1.2.3 2014-8-6
- Added missing references to LibAddonMenu.lua files that was causing an error.

1.2.2 2014-8-6
- Fixed a bug where full-text search would show an error if a book was missing its body.

1.2.1 2014-8-5
- Fixed a error caused by a change to the Scene Manager in 1.3
- Added a function to migrate data from the "empty" account that was created by the GetDisplayName() bug in 1.2.3

1.2.0 2014-6-25
- Updated to LibAddonMenu 2.0.
- Added a SavedVariable backup reminder.

1.1.2 2014-6-24
- Fixed a bug with the "Waterlogged Journal" from Craglorn that was caused a user to lose all their data. A more robust fix will be deployed later.

1.1.1 2014-6-14
- Temporarily disabled integration with the LoreLibrary which was causing connection time-outs for some users. This feature will be re-enabled when a fix for it is found.

1.1.0 2014-5-23
- Update API version to 100004. Addon appears to be stable, so I have moved to version 1.1.0.

1.0.18 2014-5-8
- Fixed a bug with upgrading old databases that would result in an error.

1.0.17 2014-5-7
- Fixed a bug in the settings panel when a newer version of LibAddonMenu was loaded.
- Updated the bundled version of LibAddonMenu to 1.0r7

1.0.16 2014-5-5
- Added a new optional reloadui reminder feature. By default, after finding 5 new books the game reminds you in a chat message to reloadui so that you do not lose much progress in the case of a crash.
- Fixed a bug with non-english clients that was preventing keybindings from working.
- Added the current version number to the UI.

1.0.15 2014-4-30
- Fixed an error that occurred when viewing a book that was not already in the collection.

1.0.14 2014-4-30
- Added a new unread indicator to the book reader. The indicator can be disabled in the settings.

1.0.13 2014-4-30
- Added the ability to toggle a book's unread status while reading it.

1.0.12 2014-4-29
- Added full-text search feature.

1.0.11 2014-4-28
- Added the LoreLibrary import feature.
- Fixed a error when changing the time display setting.

1.0.10 2014-4-28
- Fixed an error that was occurring when upgrading users of an older version of Librarian. Sorry I missed that!

1.0.9 2014-4-25
- From user feedback, performance looks to have been fixed! Moving back onto features.
- Added an unread book counter

1.0.8 2014-4-24
- Completely revamped the code to use ZO_SortFilterList as the basis of the Librarian book list. Hopefully performance is significantly improved, both for scrolling, and loading / exiting the game.

1.0.7 2014-4-21
- Added a setting to specify whether or not to display alerts in chat and/or as a banner-type alert.

1.0.6 2014-4-17
- Fixed a bug with the keybinding unread / read display when a book is highlighted.
- Replaced the chat alert when finding a new book with an alert similar to when finding a new lore book.

1.0.5 2014-4-17
- Fixed a bug with toggling the read / unread status of books.

1.0.4 2014-4-17
- Account-wide book access. There is a checkbox available at the bottom of the Librarian interface to toggle the showing of books seen across any of your characters. Initially, you will need to log in each character once to move their data to the account-wide Library.
- Big changes on the data storage side. Actual book data is stored in an account-wide variable, and only the time found is stored per-character.

1.0.3 2014-4-15
- Added a settings screen which can be accessed from the standard settings menu.
- Added a time format setting so the user can choose between 12 and 24 hour time. This setting should default to 12 hour for english and 24 hour for other languages, which is the same logic the game itself uses.
- Fixed the bug where times were always being displayed as "P.M."

1.0.2 2014-4-14
- Added a book count header.
- Fixed a bug with highlighting of sort headers.
- Known issue: book found times are still inconsistent.

1.0.1 2014-4-13
- Added a wordcount field.
Archived Files (51)
File Name
Version
Size
Uploader
Date
3.10
30kB
Orionik
10/10/23 06:08 PM
3.10
31kB
Orionik
08/23/23 07:00 AM
3.9
30kB
Orionik
06/05/23 11:04 PM
3.8
30kB
Orionik
03/13/23 10:17 PM
3.7
30kB
Orionik
11/13/22 12:29 PM
3.6
28kB
Orionik
11/01/22 07:31 PM
3.5
28kB
Orionik
10/10/22 07:40 PM
3.4
24kB
Flamage
09/11/22 05:04 PM
3.3
23kB
Orionik
08/23/22 09:45 PM
3.2
23kB
Orionik
08/06/22 09:56 AM
3.1
22kB
Orionik
08/02/22 11:03 AM
3.0
21kB
Orionik
07/25/22 12:00 PM
2.0
56kB
calia1120
02/13/18 12:56 AM
1.9
55kB
calia1120
09/10/17 08:59 PM
1.8
53kB
calia1120
06/11/17 01:02 AM
1.7.0
53kB
calia1120
02/05/17 03:00 AM
1.6.3
41kB
calia1120
09/10/16 05:51 AM
1.6.2
41kB
calia1120
09/10/16 02:09 AM
1.6.1
38kB
Flamage
03/29/15 03:59 PM
1.6.0
34kB
Flamage
03/22/15 09:38 PM
1.5.0
34kB
Flamage
11/05/14 03:47 PM
1.4.0
34kB
Flamage
09/15/14 08:58 PM
1.2.6
34kB
Flamage
09/04/14 10:57 AM
1.2.5
33kB
Flamage
08/17/14 04:44 PM
1.2.4
33kB
Flamage
08/14/14 04:56 PM
1.2.3
33kB
Flamage
08/05/14 05:52 PM
1.2.2
32kB
Flamage
08/05/14 04:22 PM
1.2.1
32kB
Flamage
08/04/14 05:01 PM
1.2.0
31kB
Flamage
06/26/14 05:22 AM
1.1.3
14kB
Flamage
06/25/14 04:29 AM
1.1.2
14kB
Flamage
06/24/14 04:49 AM
1.1.0
14kB
Flamage
06/13/14 05:32 PM
1.1.0
14kB
Flamage
05/23/14 05:02 AM
1.0.18
14kB
Flamage
05/08/14 01:55 AM
1.0.17
14kB
Flamage
05/06/14 03:20 PM
1.0.16
13kB
Flamage
05/05/14 05:22 AM
1.0.15
12kB
Flamage
04/30/14 02:23 AM
1.0.12
12kB
Flamage
04/29/14 06:05 PM
1.0.14
12kB
Flamage
04/29/14 04:42 PM
1.0.13
12kB
Flamage
04/29/14 03:49 PM
1.0.12
12kB
Flamage
04/28/14 04:01 PM
1.0.10
11kB
Flamage
04/27/14 03:11 PM
1.0.9
11kB
Flamage
04/24/14 04:19 PM
1.0.7
12kB
Flamage
04/20/14 09:54 PM
1.0.6
11kB
Flamage
04/17/14 07:03 AM
1.0.5
12kB
Flamage
04/16/14 10:57 PM
1.0.4
11kB
Flamage
04/16/14 03:10 PM
1.0.3
10kB
Flamage
04/14/14 04:16 PM
1.0.2
5kB
Flamage
04/13/14 04:00 PM
1.0.1
5kB
Flamage
04/12/14 07:48 PM
1.0
4kB
Flamage
04/10/14 02:23 AM


Post A Reply Comment Options
Unread 11/26/23, 10:14 AM  
Orionik

Forum posts: 1
File comments: 8
Uploads: 0
It used to be the full text indeed but I changed that in the first updates that I made on this addon to limit the size of the save as I was encountering some issues when saving books from an account having more than 5000 books
Especially as ESO API is allowing to access book content from anywhere (no need to copy it into the save) and it was also fixing issues about people switching language as the books read from Librarian were displayed in the language of their first discovery.

Although, even with this change, it seems that for my character with 5000 books, the call to RequestAddOnSavedVariablesPrioritySave doesn't do anything. My save file is around 2MB just with this character, so I guess it is too big for the priority save to happen.
It probably works well on character having just a few books but eventually it will stop working. So to avoid silent fail I prefer to not introduce this change into the addon and keep the alert message. Like Baertram said it is safer to do a manual /reloadui or use the key-binding added in this addon to trigger the reload with just a few pressed keys
Report comment to moderator  
Reply With Quote
Unread 11/14/23, 02:53 AM  
SlippyCheeze
AddOn Author - Click to view AddOns

Forum posts: 53
File comments: 272
Uploads: 1
Originally Posted by Baertram
Keep in mind that priority save is handled by the game and done in between and should be ONLY used for very small amount of "critical data" and NOT on every update of your addon settings etc.
If this is about saving new collected book positions etc. to the SV: Okay.
The data is just the list of book ID and timestamps, no full text.
Report comment to moderator  
Reply With Quote
Unread 11/13/23, 02:12 PM  
Baertram
Super Moderator
 
Baertram's Avatar
ESOUI Super Moderator
AddOn Author - Click to view AddOns

Forum posts: 4881
File comments: 5947
Uploads: 78
Keep in mind that priority save is handled by the game and done in between and should be ONLY used for very small amount of "critical data" and NOT on every update of your addon settings etc.
If this is about saving new collected book positions etc. to the SV: Okay.
If this is to save book texts it most probably won't fit in the priority save methods timeframe available as it is only able to save very small kind of data like a flag on/off or similar.

And as many addons could use that priroty save one should not miss-use the feature so all work fine in combination
Do not use that for whole book texts, and all addon settings or anything more than a small flag or changed value that really needs to save "in time".


Better justdo a manual /reloadui during your gameplay to save all properly to the disk/SSD


Originally Posted by SlippyCheeze
hey, thanks for the addon! I made a change to enhance it a bit locally, and thought you might want to integrate itócalling the ZOS API to request a "priority save" of the addon data, when it would spit out the "reloadui" reminder.

Lua Code:
  1. -- LibrarianData.lua, line 167, disable the alert, and then ask for a save...
  2. -- d(GetString(LIBRARIAN_RELOAD_REMINDER))
  3. GetAddOnManager():RequestAddOnSavedVariablesPrioritySave(Librarian.name)
  4. self.newBookCount = 0
Last edited by Baertram : 11/13/23 at 02:15 PM.
Report comment to moderator  
Reply With Quote
Unread 11/13/23, 12:24 PM  
SlippyCheeze
AddOn Author - Click to view AddOns

Forum posts: 53
File comments: 272
Uploads: 1
hey, thanks for the addon! I made a change to enhance it a bit locally, and thought you might want to integrate itócalling the ZOS API to request a "priority save" of the addon data, when it would spit out the "reloadui" reminder.

Lua Code:
  1. -- LibrarianData.lua, line 167, disable the alert, and then ask for a save...
  2. -- d(GetString(LIBRARIAN_RELOAD_REMINDER))
  3. GetAddOnManager():RequestAddOnSavedVariablesPrioritySave(Librarian.name)
  4. self.newBookCount = 0
Report comment to moderator  
Reply With Quote
Unread 10/10/23, 06:14 PM  
Orionik

Forum posts: 1
File comments: 8
Uploads: 0
Re: Update version info

Updated, sorry I completely forgot about this number there
Report comment to moderator  
Reply With Quote
Unread 10/10/23, 12:13 PM  
nightstrike2

Forum posts: 15
File comments: 32
Uploads: 0
Update version info

Could you update the version number in Librarian.txt? It still says 1.0, which confuses Minion into always thinking that it's out of date.
Report comment to moderator  
Reply With Quote
Unread 01/13/23, 10:02 AM  
Lukes78

Forum posts: 0
File comments: 2
Uploads: 0
Back to ESO and I can't believe this add-on has finally been updated. As a roleplayer and book reader this was always a fundamental download for me. Thanks a lot
Report comment to moderator  
Reply With Quote
Unread 11/13/22, 12:43 PM  
Orionik

Forum posts: 1
File comments: 8
Uploads: 0
Thank you very much @KomeSake for the translation, I have just updated the add-on with it. It should be soon available, it usually takes a few hours before getting validated.

If anyone else want to suggest some translation for their language, don't hesitate to do it and suggest your translation like KomeSake did, I would gladly add them to the addon.
Report comment to moderator  
Reply With Quote
Unread 11/11/22, 09:41 PM  
KomeSake
 
KomeSake's Avatar

Forum posts: 0
File comments: 4
Uploads: 0
Thank you very much for your contribution, the game Elder Scrolls is famous precisely because of the huge world view, and having these books can help me to understand the world very well. And now with this marker system, it's fantastic! I made a Chinese plugin for your plugin, I hope more people will use it, thanks again for your work!
(Sorry, my English is not good, this is a translation)
https://drive.google.com/file/d/1lrP...ew?usp=sharing
Last edited by KomeSake : 11/12/22 at 02:27 AM.
Report comment to moderator  
Reply With Quote
Unread 09/12/22, 02:12 AM  
Inspector_Miles

Forum posts: 0
File comments: 23
Uploads: 0
Originally Posted by Orionik

Yeah, I also thinks it makes sense so I have added this in the next version (v3.4)
Oh, thank you
Report comment to moderator  
Reply With Quote
Unread 09/11/22, 05:12 PM  
Orionik

Forum posts: 1
File comments: 8
Uploads: 0
Originally Posted by Inspector_Miles
Can you add option delete books? I have some books on another language and want to delete them.
Yeah, I also thinks it makes sense so I have added this in the next version (v3.4)

Although, I added this only for books which are not part of a collection (in the lore library). Because, these would be added back automatically in Librarian upon next login (or reload UI) as Librarian automatically gather all of the books from your eidetic memory during its initialization. And anyway, these books are always displayed in the language you use so they shouldn't cause an issue
Report comment to moderator  
Reply With Quote
Unread 09/10/22, 04:50 AM  
Inspector_Miles

Forum posts: 0
File comments: 23
Uploads: 0
Can you add option delete books? I have some books on another language and want to delete them.
Report comment to moderator  
Reply With Quote
Unread 07/30/22, 05:53 PM  
Orionik

Forum posts: 1
File comments: 8
Uploads: 0
Originally Posted by thejadefalcon
The update worked fine, except that it got rid of all of my "read" tags, meaning I now have over 4,500 books to go through and work out which I've read already. I still have the backup saved variables, is there any way to piece them together at all?
I am sorry it caused this issue.
I have sent you a private message so we can go more in depth into this issue don't hesitate to answer me there .
Report comment to moderator  
Reply With Quote
Unread 07/29/22, 06:55 AM  
thejadefalcon

Forum posts: 0
File comments: 79
Uploads: 0
The update worked fine, except that it got rid of all of my "read" tags, meaning I now have over 4,500 books to go through and work out which I've read already. I still have the backup saved variables, is there any way to piece them together at all?

Edit: This has been resolved by the addon dev!
Last edited by thejadefalcon : 08/05/22 at 10:49 AM.
Report comment to moderator  
Reply With Quote
Unread 07/27/22, 12:29 PM  
dominoid
AddOn Author - Click to view AddOns

Forum posts: 34
File comments: 276
Uploads: 2
Glad to see this get a significant update. Thanks for the hard work.
Report comment to moderator  
Reply With Quote
Post A Reply



Category Jump: