Skip to content

Commit 2a255ee

Browse files
authored
Create README.md for VS Menu project
Added detailed README for VS Menu, outlining features, build notes, and credits.
1 parent c22a959 commit 2a255ee

File tree

1 file changed

+92
-0
lines changed

1 file changed

+92
-0
lines changed

README.md

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
# VS Menu (Vampire Survivors Overlay)
2+
3+
A small in-game overlay for Vampire Survivors that lets you view/tweak a bunch of run-time stuff.
4+
5+
In the beginning it was only intended to be a stat editor, hence the repo name but ended up poking at several more things as time went on :)
6+
7+
<img width="318" height="1199" alt="image" src="https://github.com/user-attachments/assets/0a817ad1-774d-4a9e-a32f-74731545d140" />
8+
9+
---
10+
11+
## What it does
12+
13+
### Character tab
14+
- **Character selector** for selecting between either yourself (default) or any other NPC or friend(s) playing alongside you :)
15+
- Quick toggles:
16+
- God Mode
17+
- One Hit Kills
18+
- Random Level Up
19+
- Limit Break + Random Limit Break
20+
- Live editable values:
21+
- Level, XP, Kills, Gold, Session Gold
22+
- Max Weapons, Max Passives
23+
- Player stats editing:
24+
- Max Health, Recovery, Armor, Move Speed
25+
- Might, Projectile Speed, Duration, Area
26+
- Cooldown, Amount
27+
- Revivals left / used
28+
- Magnet radius
29+
- Pickup mode popup:
30+
- Normal
31+
- Gems and Coins Only
32+
- Gems, Coins and Roasts
33+
- Gems, Coins, Roasts and Souls
34+
- Ignore All
35+
36+
Also shows per second deltas for levels, xp, kills and gold.
37+
38+
### Music tab
39+
- Song list with:
40+
- Search filter
41+
- Tooltips for song credit(s)
42+
- Auto scroll to the selected track when you enter the tab and when changing the song via the random option or previous/next buttons.
43+
- Controls:
44+
- Stop Music
45+
- Previous / Next
46+
- Jump to a Random Track
47+
- Modifiers:
48+
- Forsaken (slower and pitched down)
49+
- Normal
50+
- Hyper (faster and pitched up)
51+
52+
### Engine tab
53+
- Camera zoom
54+
- Timescale control
55+
- SFX Volume + Music Volume
56+
- Survived time display/edit (shows formatted time, manual edit uses raw seconds as float)
57+
58+
### Misc tab
59+
- Accent color picker that immediately re-applies the full theme
60+
- Log console: (for development but left it in anyways)
61+
- Clear log
62+
- Auto scroll
63+
- Errors-only filter
64+
- Search filter
65+
- Click a log line to copy it to clipboard
66+
67+
---
68+
69+
## Build notes
70+
- **Language(s):** C++ (MASM available if needed)
71+
- **UI:** Dear ImGui
72+
- **Renderer:** DirectX 11
73+
- **Platform:** Windows
74+
75+
To build this repo, install PolyHook2 via vcpkg (`polyhook2:x64-windows-static`), or replace the hooking layer with your own implementation.
76+
77+
---
78+
79+
## Safety, fairness, and common sense
80+
This is a runtime modding tool. You can absolutely break a run if you push values too far since I don't clamp most things!
81+
82+
---
83+
84+
## Roadmap (if i feel like it one day)
85+
- more Engine tab stuff as it's kinda bare compared to the rest of the tabs
86+
87+
---
88+
89+
## Credits
90+
- Dear ImGui
91+
- PolyHook2
92+
- Vampire Survivors (for being fun to play and poke at)

0 commit comments

Comments
 (0)