MQ2Nav

View details
Authors	brainiac, Knightly, dannuic, eqmule, plure, xowis, jdowling, drwhomphd, ChatWithThisName, Sic
Software type	Plugin
Config file	MQ2Nav.ini, Zones.ini ;
Maintained	Yes and supported
Links	🏠Resource (review) ; 🥤Quick start •🤝Support •🛠️Repository

MQ2Nav
	Assist with intelligent navigation using a Navigation mesh of a zone file.

MQ2Nav allows intelligent navigation and pathfinding in EverQuest. The plugin also includes an optional in-game overlay.

Nav can navigate to doors, items, characters, and even custom waypoints. It can handle tricky terrain including doors and stairs, and navigation can be customized based on an area in the zone. New users can easily create zone meshes with the Meshgenerator tool, and even test paths within the Meshgenerator.

Commands

Syntax	Description
/navigate <settings> \| <navigation> [<option=parameter>]	Navigates your character to locations, spawns, way-points and more. To configure via GUI, `/navigate ui` Common abbreviation: /nav

Settings

It's best to configure Nav's settings through the user interface, /nav ui, but here's an example config/MQ2Nav.ini,

[Settings]
AutoBreak=1
AutoPause=0
AutoReload=1
ShowUI=1
ShowNavPath=1
AttemptUnstuck=0
OpenDoors=1
IgnoreScriptedDoors=1
UseSpawnFloorHeight=1
UseFindPolygonExtents=0
FindPolygonExtentsX=2.000000
FindPolygonExtentsY=4.000000
FindPolygonExtentsZ=2.000000
MapLineEnabled=1
MapLineColor=4278255360
MapLineLayer=3
VisualNavPathBorderColor=0
VisualNavPathHiddenColor=14391348
VisualNavPathVisibleColor=1033457
VisualNavPathLinkColor=14365848
VisualNavPathVisibleOpacity=0.800000
VisualNavPathHiddenOpacity=0.600000
VisualNavPathBorderWidth=0.200000
VisualNavPathLineWidth=0.899999
DebugRenderPathing=0

resources/Zones.ini is also used by the plugin to identify zones.

Exported Functions

Nav has functions that can be used in your own plugins. A list is kept up to date on this page.

Top-Level Object(s)

TLOs added by MQ2Nav:

TLO	Data Type(s)	Description
Navigation	Navigation	The alias Nav is more commonly used than Navigation.

Members. More may be available if inherited. Typical usage, /echo ${TLO.Member}

TLO	Data Type	Return Type	Member	Description
Navigation	Navigation	bool	Active	Returns true if navigation is currently active
			MeshLoaded	Returns true if a mesh is loaded in the current zone
			PathExists[parameters]	Returns true if the specified navigation parameters results in a navigatable path. Navigation parameters are the same parameters that would be passed to /nav, see example below.
			PathLength[parameters]	Similar to PathExists, but returns the length of the path if one is found. Navigation parameters are the same parameters that would be passed to /nav.
			Paused	Returns true if navigation is currently paused
		int	Velocity	Returns current velocity of the player, rounded to nearest integer.
		string	Setting[<key>]	Will return the string value of the setting Example: /echo ${Navigation.Setting[OpenDoors]}

Commands

Settings

Exported Functions

See also

Top-Level Object(s)