Skip to content

Commit 6bded79

Browse files
authored
Updated README.md
Added a lot of information to the README regarding requirements and usage. Will need to be updated soon as project will be renamed to Yet Another Ragdoll Mod (YARM).
1 parent 52c9ea6 commit 6bded79

1 file changed

Lines changed: 28 additions & 2 deletions

File tree

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,28 @@
1-
# GTAV-Ragdoll-Mod
2-
Input-driven Player Ragdoll Mod for GTA V.
1+
# Yet Another Ragdoll Mod (YARM)
2+
3+
Yet another Ragdoll Mod for GTA V that I created because the other Ragdoll mods didn't have the options I wanted or... none at all.
4+
So here is my take on a the good ol' ragdoll mod.
5+
6+
## Requirements
7+
- GTA V
8+
- [C++ Script Hook V](http://www.dev-c.com/gtav/scripthookv/)
9+
- [Script Hook V .NET](https://github.com/crosire/scripthookvdotnet)
10+
- [.NET Framework 4.8](https://dotnet.microsoft.com/download/dotnet-framework/net48)
11+
- [Visual C++ Redistribution x64](https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads)
12+
- Scripting
13+
- [Script Hook V .NET 3](https://www.nuget.org/packages/ScriptHookVDotNet3/)
14+
15+
## Usage
16+
Once pulled from Github, ensure that `Script Hook V .NET 3` is installed - if so, compiling should just work.
17+
18+
If you wish to have the .dll and .ini files to be automatically moved to the SHVDN scripts folder, please create a file called `GTA Folder Path.txt` in the `GTAV-Ragdoll-Mod` folder.
19+
20+
Such as: `..\GTAV-Ragdoll-Mod\GTAV-Ragdoll-Mod\GTA Folder Path.txt`
21+
22+
Then provide the file with your path to your GTA V install and do not give the path a trailing backslash on the path.
23+
24+
Example: `C:\Program Files (x86)\Steam\steamapps\common\Grand Theft Auto V`
25+
26+
## Tasks
27+
- [ ] Rename the Project and related files to Yet Another Ragdoll Mod
28+
- [ ] Upload to [gta5-mods.com](https://gta5-mods.com)

0 commit comments

Comments
 (0)