Add README

This commit is contained in:
Salt 2020-08-27 07:09:34 -05:00
parent ca86cbd01e
commit 3fd70a902d

34
README.md Normal file
View File

@ -0,0 +1,34 @@
# Salt's Shitty Text Mod
An exercise in what not to put in a text mod.
## What Is It?
It's a shitty text mod for Risk of Rain 2.
## How Do I Use It?
1. Go to the Releases tab.
2. Pick the last release.
3. Extract it into `Risk of Rain 2/Risk of Rain 2_Data/Language/`, name it whatever you want so long as the directory structure looks like this:
```
Risk of Rain 2
Risk of Rain 2_Data
Language
thisshittytextmod
language.json
blah.json
CharacterBodies.txt
icon.png
```
Restart your game and you can now select it from the Languages menu in the upper-right of the main menu. It's anmed "Salty".
I recommend restarting your game afterward because the text in the opening cutscene was changed.
## I Want My Dumb Memes in Your Mod
Open a fucking issue, then.