Skip to content

Commit 3f1a9f3

Browse files
author
siegrest
committed
Update readme
1 parent 3c0f5ab commit 3f1a9f3

File tree

2 files changed

+29
-2
lines changed

2 files changed

+29
-2
lines changed

README.md

+29-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,33 @@
11
# Exiled Presence
22

3-
A Discord rich presence client Path of Exile.
3+
![Image2](Resources/image.gif)
44

5-
Readme and program are WIP. It is currently still in the early alpha stages, meaning bugs and unimplemented code paths can be found on the master branch.
5+
## About
6+
7+
Despite many popular online games adding rich presence support to Discrd, Path of
8+
Exile has not. This is a third party tool that scans the game's log file and displays
9+
game events on your Discord profile.
10+
11+
## Usage
12+
13+
Download the application from [releases](https://github.com/siegrest/Exiled-Presence/releases). It should work out-of-the-box.
14+
15+
Upon running the executable it will start searching for the game process.
16+
Once found, it will attempt to parse the game's log file. Note that if the log file
17+
is over 10MB in size this can be extremely slow and resource consuming (you will get
18+
a warning message if this is the case).
19+
20+
To have it display information about your character one of two things are required.
21+
First, right click the tray icon and open up the "menu". Navigate to the `config`
22+
tab and input your account name so the program can get the character you're playing.
23+
If your profile is set to private, the POESESSID is requird as well. The instructions
24+
on how to find your POESESSID can be found in the correct menu or simply by googling.
25+
26+
All config option will be saved and automatically loaded the next time you run the
27+
application.
28+
29+
Navigate back to the main menu and stop and restart the service. After this you can
30+
input `X` to hide the console, the service will remain running in the tray.
31+
32+
Load up the game and log in, you should see your Discord presence update momentarily.
633

Resources/image.gif

36.1 KB
Loading

0 commit comments

Comments
 (0)