This is a wiki for a reason. Anyone can contribute. If you see something that is inaccurate or can be improved, don't ask that it be fixed--just improve it.
[ Disclaimer, Create new user --- Wiki markup help, Install P99 ]

EQHTML

From Project 1999 Wiki
Jump to: navigation, search

EQHTML is a simple VBScript parser that reads files created by the /note and /outputfile commands as well as your logs to generate a suite of HTML pages listing your character data as an out-of-game reference. (For a more robust solution, try the beta version of my new WinEQDB application, which is a Windows program with a lot more functionality.

Download Link: https://tinyurl.com/eqhtml

The EQHTML desktop version main page.
The EQHTML desktop version main page.
The EQHTML desktop version spells/missing spells section.
The EQHTML desktop version spells/missing spells section.

Contents

What it Does

EQHTML reads the inventory and spellbook outputfiles to pull together your complete equipped/bagged/banked inventory, your entire spellbook, and if you're a caster, a list of spells you are missing. It also reads your log file to find out where you are bound and where you last parked your character. Finally, it imports the file created by the /note command. (Notes are shared among all of your characters.) After importing all of that data, it generates two files for each character, named like kobayashi.htm and kobayashi-m.htm. The -m.htm versions are intended to be more readable on mobile devices. If you put the files in a cloud-synchronized folder (such as with Google Drive, OneDrive, or DropBox) you can open the files on your mobile device. (You could also e-mail them to yourself to read on your phone, if that doesn't seem kind of sad to you.) Each of the desktop versions of the files (the ones without the -m in the filename) links to each of the others, so you can browse from one character to the next without opening each individually. (Due to the differences in how linking works between hosting your mobile versions on Google Drive, OneDrive, DropBox, and others, I have intentionally omitted the links to other files on the mobile-friendlyish versions.)

How to Set it Up

  1. Make make sure you have Log=TRUE set in the [Defaults] section of your eqclient.ini file (found in the Everquest game folder).
  2. Within the game itself (for each of your characters), set up an Output hotkey and get in the habit of clicking it before you camp. It should look something like this (substituting "charactername" for your character's name):

    /outputfile inventory charactername_inventory.tab

    /outputfile spellbook charactername_spellbook.tab

    /charinfo

    Note: If you already have a hotkey set up for outputfiles, you may just need to edit it to change from .txt to .tab.)

  3. After creating the hotkey, click it to generate your first outputfiles.

  4. Download the zip file and extract it into a folder on your PC.

    Note: If you intend to use the mobile aspect of it, you might want to put that folder in your cloud service folder (such as within your "My Drive" folder if you use Google Drive). If you expect you'll stick to the desktop versions most of the time, it might be easier to create the folder on your desktop.

  5. Note the path to that folder, and edit EQHTML-add.vbs, EQHTML-desktop.vbs, and EQHTML-mobile.vbs, changing the line in each for Const EQHTMLFolder to that path.
  6. Edit the EQHTML.ini file, updating the following paths:

    EQFolder - set to the folder on your computer where the game is installed.

    EQLogsFolder - set to the folder on your computer where the game stores your characters' log files. (This is usually a folder called 'Logs' inside the game folder, but in some installations it may be elsewhere on your computer.)

    EQOutputFolder - set to the folder where files are created when you run the /outputfile command in game. (This is usually the same as the game folder, but you can store them elsewhere.)

  7. Remove the sample character(s) from the [Characters] section of the file.
  8. Save and close the file.
  9. Run EQHTML-add.vbs and answer the prompts to add your characters. (This will update EQHMTL.ini with your character list.)
  10. Run EQHTML.vbs to generate the output files.
  11. Open the .htm file for one of your characters.

Dealing with Updates

The current version of EQHTML is 3.0. (You can find out what version you're using by looking at the very bottom line of one of the desktop-version .htm files.) I may occasionally update the file package. When you download updates, note the following:

  • Be careful not to overwrite your existing copy of EQHTML.ini, or you'll have to add your characters all over again.
  • Don't forget to edit EQHTML-add.vbs, EQHTML-desktop.vbs, and EQHTML-mobile.vbs, changing the line in each for Const EQHTMLFolder to the folder in which you keep EQHTML.

Contacting Me

I mean, don't, if it's just for help setting it up or to tell me you don't like this tool. I'm not going to do tech support for this - if you need help getting it set up, ask one of your grandkids or something. But if you feel like saying "hey, I tried that thing you made and kind of like it a little bit", you can find me in game on Blue on Kobayashii of <Castle> (or any of the alts listed on that Magelo_Blue page), on Discord as kobayashiimaruu, or in the Facebook Everquest P99 group as LenPal.

Change Log

  • Version 3.0 - Added new section GINA Triggers that generates trigger text for GINA to watch for missing spells.
  • Version 2.5 - Renamed EQHTML.vbs to EQHTML-desktop.vbs, and changed EQHTML.vbs to run both the destkop and mobile versions of the process from one script.
  • Version 2.4 - Fixed order of cleric spells displayed on the missing spells list.
  • Version 2.3 - Fixed some known misspellings of spells in the outputfile that don't match the actual spell name in the wiki, and added framework to make it easier to fix them if additional misspelled spells are identified in the future.
  • Version 2.2 - When checking for missing spells, the comparison is now case-insensitive, which mitigates some issues in which the wiki spell lists did not match the name listed by the /outputfile spellbook command.
  • Version 2.1 - Added bind point to the summary at the top, right below Last Zone. To make this work effectively, you should add /charinfo on a new line in your hotkey that exports the inventory and spellbook data.
  • Version 2.0 - Now imports the in-game Notes content from the notes.txt file located in the Everquest game folder. If you don't use notes (and therefore the file is empty), you won't see anything new. If you do use notes, you will now see a link below the "Last Zone" line of any character pointing to the Notes display page. This is a desktop-only feature.
  • Version 1.7 - Added EQHTML-add.vbs, which allows you to add characters without manually editing the EQHTML.ini file.
  • Version 1.6 - Displays version number.
  • Version 1.53 - Stopped creating links when a slot is "Empty"
  • Version 1.52 - Peggy cloak was showing FALSE in blue instead of maroon.
  • Version 1.51 - Footer text was showing in wrong place for melee classes.
  • Version 1.5 - Spell scrolls weren't linking properly because their wiki pages link to the spell info instead of a page for the spell scroll.
  • Version 1.42 - Updated the readme.txt file to note that the allspells.tab file needs to be in the same folder as the .vbs files.
  • Version 1.41 - Added the last zone the character was in, so you know where each toon is camped.
  • Version 1.4 - Added the summary of key items (epic, keys, etc.) at the top of the page.
  • Version 1.3 - Fixed the order of "Known Spells" to be in level order instead of spellbook order, and added "Missing Spells" list.
  • Version 1.2 - Added a desktop-friendly version, and renamed the original version "EQHTML-mobile.vbs".
  • Version 1.1 - I really don't remember what was changed here, and hadn't started the changelog yet.
  • Version 1.0 - Proof-of-concept mobile-friendlyish HTML output.