Refresh README for standalone WowPresence folder
This commit is contained in:
Dusk-92
@@ -2,7 +2,7 @@
|
||||
|
||||
Native Discord Rich Presence for **World of Warcraft 1.12.1 (build 5875)** and compatible clients.
|
||||
|
||||
Focused on a **small game-side footprint, stable character detection and native Discord IPC**.
|
||||
Focused on **simple installation, read-only game sampling and native Discord IPC**.
|
||||
|
||||
> WowPresence targets **WoW 1.12.1 / build 5875-compatible client environments**.
|
||||
|
||||
@@ -13,35 +13,36 @@ Focused on a **small game-side footprint, stable character detection and native
|
||||
- A compatible DLL loader such as **VanillaFixes**
|
||||
- A free **Discord Application ID**
|
||||
|
||||
The DLL only samples character information from the game. Discord communication is handled by a separate companion process.
|
||||
The DLL only reads character status from the game. Discord communication is handled by the separate `WowPresence.exe` companion process.
|
||||
|
||||
## 📦 Installation
|
||||
|
||||
1. Download **\`WowPresence.zip\`** from Releases.
|
||||
1. Download **`WowPresence.zip`** from Releases.
|
||||
2. Extract the ZIP directly into your WoW game directory.
|
||||
3. Open:
|
||||
|
||||
\`\`\`text
|
||||
.modernization_tool\WowPresence\discord_application_id
|
||||
\`\`\`
|
||||
```text
|
||||
WowPresence\discord_application_id
|
||||
```
|
||||
|
||||
4. Replace the placeholder text with **your numeric Discord Application ID**.
|
||||
5. Add \`WowPresence.dll\` to your VanillaFixes \`dlls.txt\`.
|
||||
4. Replace the placeholder with **your numeric Discord Application ID**.
|
||||
5. Add `WowPresence.dll` to your VanillaFixes `dlls.txt`.
|
||||
6. Launch WoW normally through VanillaFixes.
|
||||
|
||||
After extraction:
|
||||
After extraction, the relevant files should look like this:
|
||||
|
||||
\`\`\`text
|
||||
```text
|
||||
<WoW folder>\
|
||||
├─ WowPresence.dll
|
||||
├─ WowPresence.exe
|
||||
└─ .modernization_tool\
|
||||
└─ WowPresence\
|
||||
├─ discord_application_id
|
||||
└─ discord_broadcast_flags
|
||||
\`\`\`
|
||||
└─ WowPresence\
|
||||
├─ discord_application_id
|
||||
└─ discord_broadcast_flags
|
||||
```
|
||||
|
||||
\`WowPresence.exe\` is started automatically by the DLL and normally does **not** need to be launched manually.
|
||||
`WowPresence.exe` is started automatically by the DLL and normally does **not** need to be launched manually.
|
||||
|
||||
The runtime JSON and log files are created automatically inside the same `WowPresence` folder.
|
||||
|
||||
## 🛰️ Discord Application ID
|
||||
|
||||
@@ -56,23 +57,22 @@ To create yours:
|
||||
5. Copy the **Application ID**.
|
||||
6. Paste only that numeric ID into:
|
||||
|
||||
\`\`\`text
|
||||
.modernization_tool\WowPresence\discord_application_id
|
||||
\`\`\`
|
||||
```text
|
||||
WowPresence\discord_application_id
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
\`\`\`text
|
||||
```text
|
||||
123456789012345678
|
||||
\`\`\`
|
||||
```
|
||||
|
||||
No Discord Client Secret, bot token, or bot account is used or required.
|
||||
No Discord Client Secret, bot token or bot account is used or required.
|
||||
|
||||
If the file is missing or invalid, WowPresence leaves Rich Presence disabled and records the reason in \`WowPresence.log\`.
|
||||
If `discord_application_id` is missing or invalid, Rich Presence remains disabled and the reason is written to `WowPresence\WowPresence.log`.
|
||||
|
||||
## ✨ Features
|
||||
|
||||
- Discord Rich Presence for WoW 1.12.1.
|
||||
- Character name and guild display.
|
||||
- Level and class display.
|
||||
- Race and faction display.
|
||||
@@ -81,8 +81,9 @@ If the file is missing or invalid, WowPresence leaves Rich Presence disabled and
|
||||
- Automatic companion startup.
|
||||
- Exact WoW process tracking.
|
||||
- Read-only game-memory sampling.
|
||||
- Native Discord IPC with no bot or Client Secret required.
|
||||
- Native Discord IPC.
|
||||
- Optional privacy flags for individual character fields.
|
||||
- No bot, Client Secret or external service required.
|
||||
|
||||
## 🔧 Compatibility
|
||||
|
||||
@@ -106,40 +107,36 @@ Other modified 1.12.1 clients should be considered **untested until verified**.
|
||||
|
||||
## ⚙️ How it works
|
||||
|
||||
\`\`\`text
|
||||
```text
|
||||
WoW
|
||||
└─ WowPresence.dll
|
||||
├─ read-only character sampling
|
||||
├─ local JSON status
|
||||
├─ WowPresence\discord_wow_status.json
|
||||
└─ starts WowPresence.exe
|
||||
└─ Discord local IPC
|
||||
\`\`\`
|
||||
```
|
||||
|
||||
The DLL does not communicate directly with Discord.
|
||||
|
||||
The companion executable does not read or write WoW memory.
|
||||
|
||||
Character status is written to:
|
||||
Runtime files are kept together in:
|
||||
|
||||
\`\`\`text
|
||||
.modernization_tool\WowPresence\discord_wow_status.json
|
||||
\`\`\`
|
||||
|
||||
The companion log is written to:
|
||||
|
||||
\`\`\`text
|
||||
.modernization_tool\WowPresence\WowPresence.log
|
||||
\`\`\`
|
||||
|
||||
These runtime files are created automatically.
|
||||
```text
|
||||
<WoW folder>\WowPresence\
|
||||
├─ discord_application_id
|
||||
├─ discord_broadcast_flags
|
||||
├─ discord_wow_status.json
|
||||
└─ WowPresence.log
|
||||
```
|
||||
|
||||
## 🔒 Privacy flags
|
||||
|
||||
The included file:
|
||||
|
||||
\`\`\`text
|
||||
.modernization_tool\WowPresence\discord_broadcast_flags
|
||||
\`\`\`
|
||||
```text
|
||||
WowPresence\discord_broadcast_flags
|
||||
```
|
||||
|
||||
controls which character details are published to Discord.
|
||||
|
||||
@@ -153,7 +150,7 @@ controls which character details are published to Discord.
|
||||
| 32 | Zone |
|
||||
| 63 | All fields |
|
||||
|
||||
The release package uses \`63\` by default.
|
||||
The release package uses `63` by default.
|
||||
|
||||
If the file is deleted, WowPresence also defaults to all supported fields.
|
||||
|
||||
@@ -171,26 +168,26 @@ WowPresence targets **32-bit x86 Windows**, matching WoW 1.12.1.
|
||||
|
||||
With an x86 MSVC developer environment:
|
||||
|
||||
\`\`\`bat
|
||||
```bat
|
||||
cl /nologo /O2 /MT /W3 /LD src\WowPresence.c /Fe:WowPresence.dll /link /INCREMENTAL:NO
|
||||
cl /nologo /O2 /MT /W3 src\WowPresenceLauncher.c user32.lib /Fe:WowPresence.exe /link /SUBSYSTEM:WINDOWS /INCREMENTAL:NO
|
||||
\`\`\`
|
||||
```
|
||||
|
||||
GitHub Actions builds:
|
||||
|
||||
- \`WowPresence.dll\`
|
||||
- \`WowPresence.exe\`
|
||||
- \`WowPresence.zip\`
|
||||
- `WowPresence.dll`
|
||||
- `WowPresence.exe`
|
||||
- `WowPresence.zip`
|
||||
|
||||
The ZIP also includes the ready-to-edit configuration files.
|
||||
The ZIP includes the ready-to-edit `WowPresence` configuration folder.
|
||||
|
||||
Tags matching \`v*\` can publish these files as a GitHub Release.
|
||||
Tags matching `v*` can publish these files as a GitHub Release.
|
||||
|
||||
## 📜 Project identity & licensing
|
||||
|
||||
WowPresence is an **independent community project**.
|
||||
|
||||
Compatibility with **World of Warcraft**, **Discord**, **OctoWoW**, **VanillaFixes**, **IchaLaunch**, or other referenced projects does not imply affiliation, endorsement, sponsorship, or ownership by their respective rights holders or maintainers.
|
||||
Compatibility with **World of Warcraft**, **Discord**, **OctoWoW**, **VanillaFixes**, **IchaLaunch**, or other referenced projects does not imply affiliation, endorsement, sponsorship or ownership by their respective rights holders or maintainers.
|
||||
|
||||
**World of Warcraft**, **Warcraft**, **Blizzard Entertainment**, **Discord**, and related names and marks remain the property of their respective rights holders.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user