Download
(22 b)
Download
Updated: 04/18/18 06:05 PM
Pictures
File Info
Compatibility:
Dragon Bones (3.3)
Updated:04/18/18 06:05 PM
Created:04/05/18 03:59 AM
Monthly downloads:41
Total downloads:2,893
Favorites:14
MD5:
Pocket Apocrypha
Version: 015-100022
by: Werewolf Finds Dragon, joshmiller83

Please read this.

I'm taking another break for a while. My anxiety isn't holding up well and I need to take some time for myself to recover. Frankly, modding can be a thankless job and some of the people one is forced to interact with can be... deeply unpleasant at best, to put it in the kindest way I can and not as I truly want to. For now, I feel like my mods don't need any further work done to them. They're fine as they are. See you later, folks.

I'll be back! I'm not gone for good, I just need to set this aside for now. That's all.

One thing I will say as a final note is that it'd be nice if one could turn off the comments system and only have a bug tracker in the vein of Nexus Mods. That'd be handy for people like myself who do deal with anxiety. And I deal with a lot of anxiety.

See you around, folks. My thanks to those who were kind.


Notice: Please download the addon from this location for now, and report back in the comments if you crash while trying to import from the lore library, thank you.

Click here to check out my other addons.

The Now Actually Working edition! Sorry about that.
Description
Wouldn't it be nice if you had a Lore Library, but for every book you encountered across your travels? Recorded, readable at any point, with a way to keep track of which books you have/haven't read, sortable by various factors (such as alphabetical, the time you found the book, et ceteara), and searchable for when you're seeking out that specific bit of lore? Welcome to Pocket Apocrypha, your own little slice of Hermorah's own realm right in your proverbial pocket!

Now you don't have to stop to read every single book along the way, you can rest easy and trust that they're all being stored in your own little pocket realm to be retrieved later.

This is a port of Librarian. For more information, see the FAQ below.
Features
In the hallowed words of our dear Commandant Lassard, Pocket Apocrypha can do many, many fine things for you.
  • Captures a book (in its entirety for you to read later, accessible from a user-friendly interface;
  • When you do come back to your book, it'll look exactly as it did in the world as the addon uses the same UI for displaying books that the game itself does;
  • Whenever you collect a book the time of collection is recorded, you can then sort books to be displayed by their collection date so you can see what's new and what's old;
  • With a keypress or the push of a button (either clicking the binding or right-clicking the item in the list) you can easily mark books read or unread, to know which titles you've absorbed into your concept organ;
  • A marker in Pocket Apocrypha's interface and in the very book itself which shows you whether a book is read or unread;
  • Books can be easily imported from your Lore Library collection at the push of a button;
  • You can toggle between whether you want to show all of the books you've seen or just the books you've seen on your current character with the push of a button;
  • You can search the titles and/or the contents of books for when you have a need to find a certain old book or do a little scholarly lore research;
  • The interface can be opened via a key bind or a slash command (/apocrypha);
  • Books in Pocket Apocrypha can be sorted by a variety of factors -- title, time found, book size (word count), and unread/read;
  • Alert options for when you find a new book (center screen message, chat message, or none);
  • A reminder can be set (or not, whichever you desire) to reload your UI after a configurable amount of discovered books (so, for example, it'll remind you after 5 books found);
  • The ability to mark all of your books read/unread at the press of a button;
  • You can view the options by clicking the gear in the addon's interface, by going into the usual addons menu, or via a slash command (/apocryphaoptions);
  • It's fully localisable in every respect (only English thus far, but other languages might arrive later);
  • An incredibly safe database system which properly tracks books (including those with the same titles) via their IDs.
That is a lot of things, isn't it? Well, it's all very friendly and easy to understand, as you can see from the screenshot.

It also has a collection of utilities!
  • Backup -- Make instantiated backups of your database;
  • Restore -- Restore your latest database backup;
  • Merge -- Merge two databases together;
  • Export -- Dump a list of names of books you've read to a text file;
  • Update -- For when the database needs to be updated (I'll let you know).
There's an instructions file in the Utils folder to get you started in understanding what each utility does, along with detailed steps for their use.

If you have any further ideas, let me know in the comments.
FAQ
Q: Why port? What's wrong with Librarian?

A: That's tricky to answer. I could point at how a change in the handling of
book meidums has rendered Librarian broken, anyway, and databases ruined; I could point at how it has a number of existing bugs which I wanted to fix; I could also point at the new functionality and improved features of Pocket Apocrypha; I could... but none of those are the reason you should switch.

The main reason is that Librarian was storing books by their titles, rather than the internal book IDs supplied by Zenimax Online Studios. Here are the problems that can occur with that:
  • If two books have the same title, the new book you've encountered won't be stored even if the contents are completely different;
  • If ZOS changes the title of a book for any reason, it means you'll now have a false copy of that book under a different title which erroneously bloats your collection;
  • If ZOS changes the contents of a book (typos, corrections, changes to the book medium, et cetera), those changes will never be incorporated back into Librarian.
This is all fixed in Pocket Apocrypha. Every book you find will be stored by its unique book ID, so you won't encounter any of the above problems. Furthermore, thanks to using IDs, Pocket Apocrypha will update your books as you find them in the world again to match any changes ZOS might've made.

The release of Pocket Apocrypha was necessary. Not desirable, perhaps, but absolutely necessary.

Q: I'm a user of the original Librarian addon. Can I use my old database with Pocket Apocrypha?

A: No. I'm sorry. Due to the books being stored by title, there's absolutely no means to salvage that database. It's ruined. The sooner you start over, the better. I'm sorry to have to say it, but Librarian's database is simply that broken, you're better off going at it with a fresh start, knowing each book is stored by its ID and thus is future-proofed against any cataclysmic changes (like the ones that befell Librarian).

Q: I used the builds of Librarian you released under the comments section, can I use that database?

A: Yes. It will need to be converted but that database is 100 per cent compatible due to its use of book IDs. Use the database update utility to convert your old Librarian database over Pocket Apocrypha standards.

Q: Will you setup a system where people can share their books so that we can all have a complete database?

A: No. It'd be far too easy to inject nonsense into it as I have no means of verifying what is or is not a real book. So someone could include a book about penises, and if it were written well enough we'd be none the wiser that it wasn't in the game itself.

This would lead to people talking about ESO having books about penises. That'd be bad for everyone involved. So, sadly, this can't happen.
Credits
My ever patient beau who manages to sometimes raise my courage to the point where I can post things online.
::Version 014-100022

Fix: Book mediums being updated from CWC standard weren't properly storing their medium.

::Version 013-100022

Improvement: Changing character names in books that store character names would result in Pocket Apocrypha reporting an updated book whenever you found that on a different character. This is hardly ideal. Instead, PA now strips out the name when storing a new book and replaces it with a placeholder. When viewing the book, the placeholder is replaced with the name of the character viewing the book. I felt this was the most apt way to deal with this, and solves the problem. From now on, you should only see those books being updated once more (to get the name replaced with the placeholder), then you won't see that again.

::Version 012-100022

I noticed that the Clockwork City pro-grammatically changes the medium of its books, this is a problem since any books you already have will be updated to CWC standard when you view them there. I've included an option (which defaults to off) which doesn't update the medium for CWC books, it's off by default and it should stay that way unless a medium-related database corruption event has occurred.

I moved the main files out of the root, leaving only the initialization txt there. This is just for cleanliness's sake.

::Version 011-100022

* Updated: Changed names of dropdowns to be more descriptive.
Fix: Forgot to update locale files.

::Version 010-100022

* Update: PA now notifies you if ZOS has updated a book in any way, and there are now new options to handle how this notification occurs. If this isn't your first time using the addon, check those out and be sure to set them.
* Fix: PA used to use the character time stamp for books even if the 'Show All Books' option was enabled, this has been fixed so that now the Universal time stamp is properly used.
* Fix: PA would sometimes notify you of a new book if it was new for your character even when the 'Show All Books' option was toggled on, whereas with that option on it now only notifies you when you find a new book Universally regardless of character.


:: 006-100022

o Added a version to the txt launcher.
o ???

:: 005-100022

o Fixed issue where the keybind to open Librarian wouldn't work (SCENE_MANAGER typo).
o Fixed issue where import would cause the import function to crash (RefreshData being called with every AddBook, it isn't doing that any more).
o Fixed issue which would occur on trying to add a book (????) (not sure why this was happening but it appears to be fixed, too).
o AAAAAAAAAAAAAAAAAA

:: 004-100022

o You can now right-click on a book in the list to mark it as read/unread.

:: 003-100022

o Oops, forgot to remove an old Librarian test backup. Nothing sensitive in there other than character names; If you saw that... feel free to yell at me in-game, if you like!

:: 002-100022

o Removed a couple of localisation lines I don't need any more.

:: 001-100022

o First release. And it's size is the number of the beast. That's amazing.
Optional Files (0)


Post A Reply Comment Options
Unread 04/05/18, 02:19 PM  
Werewolf Finds Dragon
AddOn Author - Click to view AddOns

Forum posts: 17
File comments: 105
Uploads: 15
It's still not a great idea, though, Phinix. I'm sorry. I had a better one, I've already implemented it and it's working and even safer and quicker.

As I suspected, the problem was with how AddBook was being called. So I properly staggered that, instead. I'm pleased with how the import function is working, now.

Edit: Running more tests now, just to be sure. Will upload soon.

Edit: I think I know exactly what's up, thanks to testing! I think I have an even smarter idea!
Last edited by Werewolf Finds Dragon : 04/05/18 at 02:26 PM.
Report comment to moderator  
Reply With Quote
Unread 04/05/18, 01:57 PM  
Phinix
 
Phinix's Avatar
AddOn Author - Click to view AddOns

Forum posts: 186
File comments: 1781
Uploads: 32
Originally Posted by Werewolf Finds Dragon
I was just about to ask what Phinix was on. >_>;

I was also going to ask: Did anyone else see josh's post? Anyone?

Having a staggered import is a very bad idea. Pocket Apocrypha uses ESO's own lore library building code. So if the import is crashing, it's likely because a bug is happening somewhere outside of the import. The staggered import was already tried in Librarian and caused many and varied problems.

If crashes are occurring, it's likely due to the bug josh is having compounded over and over by running the import.
The previous post about the crashing issues was meant to go here. The other one was posted accidentally and meant for Nirn Auction House. You can delete that one and the response.

It is worth trying that code i posted. It is working without problems for me. Currently doing import on each of my characters to confirm total imported book count matches total known.
Last edited by Phinix : 04/05/18 at 02:03 PM.
Report comment to moderator  
Reply With Quote
Unread 04/05/18, 01:42 PM  
Werewolf Finds Dragon
AddOn Author - Click to view AddOns

Forum posts: 17
File comments: 105
Uploads: 15
I was just about to ask what Phinix was on. >_>;

I was also going to ask: Did anyone else see josh's post? Anyone?

Having a staggered import is a very bad idea. Pocket Apocrypha uses ESO's own lore library building code. So if the import is crashing, it's likely because a bug is happening somewhere outside of the import. The staggered import was already tried in Librarian and caused many and varied problems.

If crashes are occurring, it's likely due to the bug josh is having compounded over and over by running the import.
Report comment to moderator  
Reply With Quote
Unread 04/05/18, 01:35 PM  
joshmiller83
AddOn Super User
 
joshmiller83's Avatar
Premium Member

Forum posts: 70
File comments: 243
Uploads: 0
Question Re: Unknown player...

Wrong addon maybe? lol

Originally Posted by Phinix
I sold several items, however when I click "Confirm" it asks ti confirm sending then fails saying "unknown player." The player in question is @Barbarenbar974 on PC NA. He bought a ton of my stuff actually...

I am also concerned because the addon does not appear to be setting the send option to COD and entering the sale value. This is very concerning because it IS attaching the item. So, if it HAD found this guy, would it have just sent the item with no COD because I doubt very much they would have chosen to send the money on good faith!

I am also wondering what I should do with these sold items to the unknown user? Will my rating now go down because I am unable to fulfill orders?
Report comment to moderator  
Reply With Quote
Unread 04/05/18, 01:34 PM  
Phinix
 
Phinix's Avatar
AddOn Author - Click to view AddOns

Forum posts: 186
File comments: 1781
Uploads: 32
Unknown player...

Please delete, FML!
Last edited by Phinix : 04/05/18 at 01:38 PM.
Report comment to moderator  
Reply With Quote
Unread 04/05/18, 01:06 PM  
Phinix
 
Phinix's Avatar
AddOn Author - Click to view AddOns

Forum posts: 186
File comments: 1781
Uploads: 32
Fix for import crash...

EDIT: For great justice!
Last edited by Phinix : 04/06/18 at 08:14 AM.
Report comment to moderator  
Reply With Quote
Unread 04/05/18, 11:43 AM  
joshmiller83
AddOn Super User
 
joshmiller83's Avatar
Premium Member

Forum posts: 70
File comments: 243
Uploads: 0
Error upon reading a new book.

user:/AddOns/PocketApocrypha/PocketApocrypha.lua:462: operator + is not supported for nil + number
stack traceback:
user:/AddOns/PocketApocrypha/PocketApocrypha.lua:462: in function 'PocketApocrypha:AddBook'
user:/AddOns/PocketApocrypha/PocketApocrypha.lua:578: in function 'PocketApocrypha.OnShowBook'
Also cannot use the key-bind anymore.

Maybe the conversion from Librarian screwed with it somehow?
Report comment to moderator  
Reply With Quote
Unread 04/05/18, 11:34 AM  
votan
 
votan's Avatar
AddOn Author - Click to view AddOns

Forum posts: 577
File comments: 1670
Uploads: 40
Re: Import crash...

Originally Posted by Phinix
Great idea; have been looking for a mod like this!

However I must confirm crashes using the import option, on characters that either do or do not have eidetic memory, and with or without NoThankYou enabled, the game freezes and then crashes after a long pause.
Probably the same problem as I had in Potion Maker. Too many strings generated per frame.
In this case is the solution to spread import over time.
Last edited by votan : 04/05/18 at 11:51 AM.
Report comment to moderator  
Reply With Quote
Unread 04/05/18, 11:11 AM  
Phinix
 
Phinix's Avatar
AddOn Author - Click to view AddOns

Forum posts: 186
File comments: 1781
Uploads: 32
Import crash...

Great idea; have been looking for a mod like this!

However I must confirm crashes using the import option, on characters that either do or do not have eidetic memory, and with or without NoThankYou enabled, the game freezes and then crashes after a long pause.
Report comment to moderator  
Reply With Quote
Unread 04/05/18, 06:58 AM  
hagermanj

Forum posts: 2
File comments: 367
Uploads: 0
I just downloaded your addon. When I try to import from the journal database the game crashes.
Report comment to moderator  
Reply With Quote
Post A Reply



Category Jump: