Added README and screenshots

hntd187 · Apr 11, 2023 · 6f49446 · 6f49446
1 parent 57e3d61
commit 6f49446
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,25 @@
+## Resident Evil Speedrun Overlay
+
+This is a (mostly) rewritten plugin using the [reframework](https://github.com/praydog/REFramework) to provide informational assistance
+to speed runners of Resident Evil 4 remake.
+
+Currently, the plugin provides
+1. In game time
+2. Game Rank (DA)
+3. Money (Spinels and Pesetas)
+4. Nearby enemies and their health bars (Enemies are sorted by their current health value, the highest first)
+5. Current Chapter Kill Count
+6. Font Size scaling
+7. Only display boss health bars
+8. Only display X number of enemy health bars
+
+### Installation
+1. Install the [reframework](https://github.com/praydog/REFramework#installation)
+2. Go to the [releases](https://github.com/hntd187/re-speedrun-overlay/releases) page and download a release of the plugin and place the file in your `<GAME DIRECTORY>/reframework/plugins/`
+
+
+### Screenshots
+
+![Main Menu](imgs/main_menu.jpg)
+![Main Menu](imgs/island.jpg)
+![Main Menu](imgs/boss.jpg)
diff --git a/imgs/boss.jpg b/imgs/boss.jpg
diff --git a/imgs/island.jpg b/imgs/island.jpg
diff --git a/imgs/main_menu.jpg b/imgs/main_menu.jpg