moepmoep12
Path of Exile Log Events
Table of Contents
Introduction
The purpose of this library is to provide an easy to use event emitter for the game Path of Exile (PoE) by Grinding Gear Games to be used by other applications listening to events. Therefore, this library monitors the log file of the PoE client and emits events when something interesting happens ingame.
Note: This product isn't affiliated with or endorsed by Grinding Gear Games in any way.
Overview
The key objectives of this library are:
- Provide an event emitter for the PoE log file
- Fire custom events with detailed event-specific data
- Support all languages
Installation
Install the latest stable version of this library:
npm install --save poe-log-eventsGetting started
import { Language, LogOptions, PathOfExileLog } from "poe-log-events";
const logOptions: LogOptions = {
// default path for windows
logFilePath: "C:\\Program Files (x86)\\Grinding Gear Games\\Path of Exile\\logs\\Client.txt",
// can be ignored by most applications
ignoreDebug: true,
language: Language.English,
};
const poeLog = new PathOfExileLog(logOptions);
// register event handlers
poeLog.on("areaChanged", (event) => {
console.log(`Entered new area ${event.newArea} at ${event.date.toISOString()}`);
});
poeLog.on("buyItemWhisperSent", (event) => {
console.log(
`Sent buy request to buy ${event.item} for ${event.price} ${event.currency} from ${event.player}`
);
});
poeLog.on("sellItemWhisperReceived", (event) => {
console.log(
`Received request to sell item ${event.item} for ${event.price} ${event.currency} to ${event.player}`
);
});
poeLog.on("error", (err) => {
console.error(err);
});Handling errors
Errors are emitted in the error event. Hence, add a listener to the error event:
poeLog.on("error", (err) => {
console.error(err);
});Events
The available events are defined by the interface PathOfExileLogEvents. See below for a list.
| Name | Description | Type |
|---|---|---|
| error | Error occured | - |
| line | New line was parsed | INFO |
| whisperReceived | A whisper was received | INFO |
| whisperSent | A whisper was sent | INFO |
| sellItemWhisperReceived | A trade whisper for selling an item was received | INFO |
| buyItemWhisperSent | A trade whisper for buying an item was sent | INFO |
| sellBulkWhisperReceived | A trade whisper for selling an item in bulk was received | INFO |
| buyBulkWhisperSent | A trade whisper for buying an item in bulk was sent | INFO |
| areaEntered | A new area was entered | INFO |
| areaJoinedBy | The current area was joined by another player | INFO |
| areaLeftBy | The current area was left by another player | INFO |
| tradeAccepted | A trade was completed | INFO |
| tradeCancelled | A trade was cancelled | INFO |
| connected | Client connected to the PoE server | INFO |
| afk | AFK mode started | INFO |
| afkEnd | AFK mode ended | INFO |
| dnd | DND mode started | INFO |
| dndEnd | DND mode ended | INFO |
| login | Client logged in | INFO |
| chatJoined | A chat channel was joined | INFO |
| deathCount | /deaths command was executed | INFO |
| remainingMonster | /remaining command was executed | INFO |
| slain | Player was slain | INFO |
| level | Player leveled up/down | INFO |
| playedQuery | /played command was executed | INFO |
| createdQuery | /age command was executed | INFO |
| areaGenerated | A new area was generated and entered by the player | DEBUG |