AblativeAbsolute/rjw-race-support-AsmodeusRex
1
0
Fork 0
mirror of https://gitgud.io/AsmodeusRex/rjw-race-support.git synced 2024-08-15 00:03:24 +00:00
Code Issues Projects Releases Packages Wiki Activity

Tweak documentation

Browse source
This commit is contained in:
AsmodeusRex 2022-10-28 17:56:41 -07:00
parent 39f03beee8
commit 8eea7dc87e
3 changed files with 30 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
.vscode/settings.json vendored
View file

@ -132,5 +132,11 @@
"Yuki",
"Zabrak"
],
"cSpell.maxNumberOfProblems": 1000
"cSpell.maxNumberOfProblems": 1000,
"cSpell.enableFiletypes": [
"xml"
],
"editor.insertSpaces": false,
"editor.renderWhitespace": "boundary",
"files.trimTrailingWhitespace": true,
}

26
CONTRIBUTING.md
View file

@ -12,18 +12,26 @@ Help is of course always appreciated. Make sure you follow the guidelines in the
# Add support for a new mod
There are two methods to add support for a new mod. If the mod isn't doing anything super wild, the first method is preferred. Only use the second method if you can't use the first method.
No matter what method you use, you will need to know the "defName" of the races you are adding support for. This can be found in the XML files of the mod that adds those races. The path to the files you are looking for will be something like: "ModDirectory/1.4/Defs/ThingDefs_Races/animals.xml".
No matter what method you use, you will need to know the `defName` of the races you are adding support for. This can be found in the XML files of the mod that adds those races. The path to the files you are looking for will be something like: `ModDirectory/1.4/Defs/ThingDefs_Races/animals.xml`.
You will also need to fork the repository. Check out the GitHub guide at the bottom of the page.
## Setting up
### Fork the repository
Create a GitGud/Sapphire account. Hit the fork button.
### Installing tools
Install [Visual Studio Code](https://code.visualstudio.com/). This is to make use of the spelling dictionary and other VSCode specific configuration.
Install the VSCode extensions "Code Spell Checker" and "rust-analyzer".
Install [Rust](https://www.rust-lang.org/learn/get-started). Don't worry about learning rust, all you'll be doing in it is data definition from pre-defined templates.
## Method 1: Rust
This method involves adding new entries to the list of parts and races in the Rust source files (.rs).
This method involves adding new entries to the list of parts and races in the Rust source files (`.rs`).
### Racegroups
A racegroup is a group of... races that all share the same characteristics. For example, both a Cassowary and an Ostrich are in the avian animal group.
At the bottom of the file generator/src/racegroup.rs (around line 100 or so) you will find the lists of racegroups. Find the racegroup that has the right parts and skin type for each race you want to support. Simply add the defName of each race to the appropriate racegroup. Make sure to properly put the defName in alphabetical order. The scheme is as follows:
* Vanilla animals (e.g. Cobra)
* Mod animals with a mod prefix (e.g. AA_BloodShrimp)
* Mod animals without a mod prefix (e.g. Rakk)
At the bottom of the file `generator/src/racegroup.rs` (around line 100 or so) you will find the lists of racegroups. Find the racegroup that has the right parts and skin type for each race you want to support. Simply add the `defName` of each race to the appropriate racegroup. Make sure to properly put the `defName` in alphabetical order. The scheme is as follows:
* Vanilla animals (e.g. `Cobra`)
* Mod animals with a mod prefix (e.g. `AA_BloodShrimp`)
* Mod animals without a mod prefix (e.g. `Rakk`)
Remember that each category is in alphabetical order.
@ -32,9 +40,11 @@ There! You're already done. That's all that you need to do for most patches. The
If you couldn't find an appropriate racegroup for your race, look again. If you really can't find one, the process is much more complicated.
#### **Adding a new racegroup**
*Coming soon*
*Actual instructions coming soon*
Copy and paste the right racegroup def/function call into the right place alphabetically. Use `RaceGroup::standard` for humans and `RaceGroup::standard_animal` for animals. Edit the fields.
#### **Tags**
These are the available tags/skin types for a race group.
* Chitin
* Demon
* Feathers

6
ReadMe.md
View file

@ -1,10 +1,13 @@
# RJW Race Support
Provides RJW compatibility for a wide array of mods that add races and animals.
The base RJW mod automatically patches most races in a way that works, but your cat-girls by default will only have normal human genitalia. This mod fixes that, giving the appropriate anatomy to animals and people from numerous mods.
This mod requires RJW and must be placed somewhere below it.
### Supported Mods
+: Fate uncertain (I may have to update the link for it when it gets updated to 1.4, or it may not get updated at all)
-: Waiting for update
* +Add Elona Imouto Race https://steamcommunity.com/sharedfiles/filedetails/?id=1863723112
* Add Elona Shoujo https://steamcommunity.com/sharedfiles/filedetails/?id=1500213859
@ -65,7 +68,7 @@ This mod requires RJW and must be placed somewhere below it.
* Megafauna https://steamcommunity.com/workshop/filedetails/?id=1055485938
* Mincho, The Mint Choco Slime ~ HAR ver. https://steamcommunity.com/sharedfiles/filedetails/?id=2477501851
* [Dead?]Momu https://steamcommunity.com/sharedfiles/filedetails/?id=1929605886
* +Moyo-From the depth https://steamcommunity.com/sharedfiles/filedetails/?id=2182305386
* -Moyo-From the depth https://steamcommunity.com/sharedfiles/filedetails/?id=2182305386
* +Nam' Hellhounds https://steamcommunity.com/sharedfiles/filedetails/?id=2381349496
* NewRatkinPlus https://steamcommunity.com/sharedfiles/filedetails/?id=1578693166
* Nexomon https://steamcommunity.com/sharedfiles/filedetails/?id=2764736074
@ -125,6 +128,7 @@ This mod requires RJW and must be placed somewhere below it.
* Update milk mod support
* Keep an eye out for Fallout Ghoul
* FCP vertibirds, dogmeat
* Alpha mythology
#### Test and improve
* Emperor of dragon
* Gods of elona