WIP: Test refreshed object manager player detection #2

Closed
Dusk-92 wants to merge 40 commits from test/object-manager-refresh into main
Showing only changes of commit c0d297c3b9 - Show all commits
+47 -50
View File
@@ -2,7 +2,7 @@
Native Discord Rich Presence for **World of Warcraft 1.12.1 (build 5875)** and compatible clients. 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**. > 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 compatible DLL loader such as **VanillaFixes**
- A free **Discord Application ID** - 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 ## 📦 Installation
1. Download **\`WowPresence.zip\`** from Releases. 1. Download **`WowPresence.zip`** from Releases.
2. Extract the ZIP directly into your WoW game directory. 2. Extract the ZIP directly into your WoW game directory.
3. Open: 3. Open:
\`\`\`text ```text
.modernization_tool\WowPresence\discord_application_id WowPresence\discord_application_id
\`\`\` ```
4. Replace the placeholder text with **your numeric Discord Application ID**. 4. Replace the placeholder with **your numeric Discord Application ID**.
5. Add \`WowPresence.dll\` to your VanillaFixes \`dlls.txt\`. 5. Add `WowPresence.dll` to your VanillaFixes `dlls.txt`.
6. Launch WoW normally through VanillaFixes. 6. Launch WoW normally through VanillaFixes.
After extraction: After extraction, the relevant files should look like this:
\`\`\`text ```text
<WoW folder>\ <WoW folder>\
├─ WowPresence.dll ├─ WowPresence.dll
├─ WowPresence.exe ├─ WowPresence.exe
└─ .modernization_tool\ └─ WowPresence\
└─ WowPresence\
├─ discord_application_id ├─ discord_application_id
└─ discord_broadcast_flags └─ 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 ## 🛰️ Discord Application ID
@@ -56,23 +57,22 @@ To create yours:
5. Copy the **Application ID**. 5. Copy the **Application ID**.
6. Paste only that numeric ID into: 6. Paste only that numeric ID into:
\`\`\`text ```text
.modernization_tool\WowPresence\discord_application_id WowPresence\discord_application_id
\`\`\` ```
Example: Example:
\`\`\`text ```text
123456789012345678 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 ## ✨ Features
- Discord Rich Presence for WoW 1.12.1.
- Character name and guild display. - Character name and guild display.
- Level and class display. - Level and class display.
- Race and faction 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. - Automatic companion startup.
- Exact WoW process tracking. - Exact WoW process tracking.
- Read-only game-memory sampling. - 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. - Optional privacy flags for individual character fields.
- No bot, Client Secret or external service required.
## 🔧 Compatibility ## 🔧 Compatibility
@@ -106,40 +107,36 @@ Other modified 1.12.1 clients should be considered **untested until verified**.
## ⚙️ How it works ## ⚙️ How it works
\`\`\`text ```text
WoW WoW
└─ WowPresence.dll └─ WowPresence.dll
├─ read-only character sampling ├─ read-only character sampling
├─ local JSON status ├─ WowPresence\discord_wow_status.json
└─ starts WowPresence.exe └─ starts WowPresence.exe
└─ Discord local IPC └─ Discord local IPC
\`\`\` ```
The DLL does not communicate directly with Discord. The DLL does not communicate directly with Discord.
The companion executable does not read or write WoW memory. The companion executable does not read or write WoW memory.
Character status is written to: Runtime files are kept together in:
\`\`\`text ```text
.modernization_tool\WowPresence\discord_wow_status.json <WoW folder>\WowPresence\
\`\`\` ├─ discord_application_id
├─ discord_broadcast_flags
The companion log is written to: ├─ discord_wow_status.json
└─ WowPresence.log
\`\`\`text ```
.modernization_tool\WowPresence\WowPresence.log
\`\`\`
These runtime files are created automatically.
## 🔒 Privacy flags ## 🔒 Privacy flags
The included file: The included file:
\`\`\`text ```text
.modernization_tool\WowPresence\discord_broadcast_flags WowPresence\discord_broadcast_flags
\`\`\` ```
controls which character details are published to Discord. controls which character details are published to Discord.
@@ -153,7 +150,7 @@ controls which character details are published to Discord.
| 32 | Zone | | 32 | Zone |
| 63 | All fields | | 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. 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: 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 /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 cl /nologo /O2 /MT /W3 src\WowPresenceLauncher.c user32.lib /Fe:WowPresence.exe /link /SUBSYSTEM:WINDOWS /INCREMENTAL:NO
\`\`\` ```
GitHub Actions builds: GitHub Actions builds:
- \`WowPresence.dll\` - `WowPresence.dll`
- \`WowPresence.exe\` - `WowPresence.exe`
- \`WowPresence.zip\` - `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 ## 📜 Project identity & licensing
WowPresence is an **independent community project**. 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. **World of Warcraft**, **Warcraft**, **Blizzard Entertainment**, **Discord**, and related names and marks remain the property of their respective rights holders.