Usage and Features - nomns/nparse GitHub Wiki

General

System Tray Icon ()- Right Click
- Check For Updates - Opens up https://github.com/nomns/nparse/releases in your browser.
- Select EQ Log Directory - Sets your EQ Log Directory.
- Spells - Toggle visibility of the Spells window.
- Maps - Toggle visibility of the Maps window.
- Settings - Opens Settings Window
- Quit - Cleanly exit nParse. This will save your window positions.

Maps, Spells, and Discord overlay windows can be toggled on and off via in-game macros:

/tell toggle_maps
/tell toggle_spells
/tell toggle_discord

Maps Parser

General Notes:

The map files nParse uses are the same format that the in-game map client uses. You can place your own map files into the data/maps/map_files directory. Currently only maps with .txt, _1.txt, _2.txt, _3.txt, and _4.txt are loaded. For example, when you zone into "The Nektulos Forest," the following files (if they exist) will be loaded and displayed: nektulos.txt, nektulos_1.txt, nektulos_2.txt, nektulos_3.txt, nektulos_4.txt. There are some very nice map packs out there that should be 100% compatible.

Usage:

☷ button - Left click to toggle the ability to resize, move, minimize, maximize window, or hide window (clicking the X will just hide the window. To show again, right click on the system tray icon and then Maps.
Mouse Wheel - Zooms the map in and out.
Control Key (HOLD) - Shows Hand cursor. While holding control key, you can move the map view by dragging. You can also use the mouse wheel to zoom between layers if you currently have layers activated.
Right Mouse Button - Shows Menu.
- Spawn Point - Create, remove, or clear all spawn points.
  - Spawn Point can be reset by double clicking on it.
  - List of times can be found at: https://wiki.project1999.com/Zone_Spawn_Timers
- Way Point - Create or clear a temporary way point on map.
- Load Map - Manually load a map.
Toggles - Icons visible in the top right corner.
- ✪ - Toggles visibility of points of interest.
- ◎ - Toggles map to auto center on player when a new location is parsed.
- Ⓩ - Toggles Z layers which should update opacity of layers near your current Z level.
- # - Toggles visibility of grid lines blocks of 1000.
- 🛈 - Toggles visibility of coordinates showing beside mouse when hovering over the map.

Location Sharing

You can enable this feature in the Sharing settings page, and your location will be broadcast to other users with the same group key (or you can share with your current Discord channel, but this requires configuring the Discord overlay). Think of it like a password for your guild or group, so only people given access can see your location. The group key is case sensitive.

Deaths are also recorded and shared, based on your last location before you died. Remember to /loc often! Many find it useful to bind a /loc macro to a movement key.

Custom path recording

This newer feature is now available (though consider it "beta"). Your feedback is appreciated!

To use it:

Right click on the map window and choose Custom Pathing -> Start Recording.
Provide a name for your new path.
While in recording mode, every /loc will draw part of a new path on the map.
Right click and choose Custom Pathing -> Stop Recording to finish recording a path.

Alternatively, you can type /tell start_recording_PATHNAME to begin and /tell stop_recording to end recording. PATHNAME does not support spaces, but any underscores will be replaced with spaces automatically.

Custom path files are created in data/maps/map_files/recordings/ and you can share these files with others, they just need to put them in their recordings/ directory and ensure they are using at least this version of nParse. It's also possible to manually edit these files if you want to clean up the paths after initial recording. The format is as follows: Lines: L x1, y1, z1, x2, y2, z2, R, G, B Points: P x, y, z, r, g, b, size, text

Spells Parser

General notes:

The spell parser creates a wear off time based on when the spell lands. It looks like on the server, the spell will wear off on the tick after it wears off. Due to this difference, nParse's spell timer will finish 0 to 6 seconds before the server's.
Targets are tracked without knowing whether the target name is unique. Due to this, if you are fighting 3 a skeleton, the buffs/debuffs will override the previous debuff on that target.
A spell landing success window is created (Casting Window) for when the spell you are casting should resolve. If no targets are found within this Casting Window, no target is created. This reduces other's successful casts from being parsed as your own. The size of the Casting Window or whether you want to have it active is editable within the Settings Window.
The icons used are the same format as used by the client. If you have a different set of icons you use in your everquest client, override the spell images in the data/spells directory to get the spell icons you want.

Usage:

☷ button - Left click to toggle the ability to resize, move, minimize, maximize window, or hide window (clicking the X will just hide the window. To show again, right click on the system tray icon and then Spells.
lvl. (#) - Spinbox in upper right corner of window which will dictate at which level your spells are calculated for.
Double-Click:
- On Target Name: Removes target and all spells associated with target.
- On Spell: Removes spell from target.
Mouse Wheel - Scrolls spell list if scroll bar visible.
Toggles - Icons visible in the top right corner.
- ⚡ - Toggles parsing of custom timers.
Custom Spell Timers
- You can add new custom timers in the settings window under Spells then clicking the "Edit" button under general-> Custom Timers.
  - Name: This will be what shows up as the 'spell' name in the spells window.
  - Text: Creates a regex string based on what you type in. * can be used to match anything. Please note that it will try to match your text to the beginning and end of the string, so if you want to catch text within the middle of text, you will need to prepend and append your Text with *.
    - Example: '*corgi*' will match 'corgi', 'I love my corgi!', and 'my corgi loves the sploots.'
    - Example: 'corgi*' will match 'corgi', 'corgi's are awesome', but will note match 'I love my corgi!'
    - Example: '*corgi' will match 'corgi', 'I love my corgi', but will not match 'I love my corgi!'
    - You can use as many * as you like.
  - Time: Uses the format of hh:mm:ss just like spawn timers. If you type 33:30, it will default that to mm:ss. Just typing in 30 will be interpreted as 30 seconds.
- General Notes
  - This is not fully tested. If you run into any problems please create an issue and I will try to fix it as fast as possible. In the meantime, you can revert to the previous release.
  - Currently defaults all icons to icon 14.
  - Hopefully I can add more features to this in the future.

Discord Overlay

Now you can see your Discord voice channel overlay as an nParse window. You may need to authorize Discord StreamKit the first time you configure the overlay. Configuration is done via the ⚙️ icon on the nParse Discord window, or from the system tray icon.

Feature Notes

PvP Spell Durations

Within the spells_us.txt file, there is a secondary set of duration formulas and durations. It seems from my extremely limited testing of casting detrimental spells on myself, the duration coincides with the second duration formula for things like root, snare, slow, etc. So I have made an option within the Settings Window to toggle this behaviour. If it is not correct, I would love to know.