Skip to content

Commit 4f84988

Browse files
committed
Update README.md from its default Slugbase readme
1 parent aa30d45 commit 4f84988

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,31 @@
1-
Use this template on GitHub or [download the code](https://github.com/SlimeCubed/ExampleSlugBaseMod/archive/refs/heads/master.zip), whichever is easiest.
1+
# Five Cycles at Pebbles (FCAP)
22

3-
Links:
4-
- [Template Walkthrough](https://slimecubed.github.io/slugbase/articles/template.html) for a guide to this template.
5-
- [SlugBase Docs](https://slimecubed.github.io/slugbase/) for information regarding custom slugcats.
6-
- [Modding Wiki](https://rainworldmodding.miraheze.org/wiki/Downpour_Reference/Mod_Directories) for `modinfo.json` documentation.
3+
A fully-fledged Five Nights at Freddy's-inspired gamemode in Rain World!
4+
5+
## Credits
6+
7+
* Alduris - Programming, concept, assets, writing, nightcat's ballad
8+
* Beep - Artist (thank you so much, you did such an amazing job!)
9+
* DeepL.com - Initial translations
10+
* VerityOfFaith - Chinese translation help
11+
* Detrax, Mold223, TempleOfArt - Russian translation help
12+
* CHEPPR - Korean translation help
13+
* Portal79 - French translation help
14+
15+
## Installing
16+
17+
If you have Steam, you can install it through the Steam Workshop: https://steamcommunity.com/sharedfiles/filedetails/?id=3357397880
18+
19+
If you do not have Steam, download the [latest release](https://github.com/alduris/FCAP/releases/latest) (only download "fcap-1.x.x.zip"!) and put its contents in your Rain World's mods folder. If you're unsure where that is, locate your Rain World installation folder, then go to `./RainWorld_Data/StreamingAssets/mods`. You will also need to install [Slugbase](https://github.com/SlimeCubed/SlugBaseRemix/releases/latest).
20+
21+
22+
## Building
23+
24+
All references necessary to build the code are included, so all that should be necessary is forking it and opening the solution file. Builds directly to `mod/plugins`. I recommend setting up a symbolic link in your Rain World's "mods" folder linking to the "mod" folder in this repository, as it will make development easier.
25+
26+
## Contributing
27+
28+
I did an initial pass-over of all the translations using the website DeepL.com, though they are not perfect and I need proofreaders! If you are fluent in one of these languages and English and would like to correct a translation, it would be greatly appreciated! The following are where the translations are stored and their reference material:
29+
30+
* Phone guy scripts are in `mod/phoneguy/<language>/` and the reference texts are in `mod/phoneguy/eng`
31+
* Menu text is in `mod/text/text_<language>/strings.txt`, reference text is included in the file.

0 commit comments

Comments
 (0)