From e61e55a5191ee3403d1cd3453a2506c9157b4b6e Mon Sep 17 00:00:00 2001 From: Chunnyluny <102756485+Chunnyluny@users.noreply.github.com> Date: Wed, 30 Aug 2023 21:59:18 +0200 Subject: [PATCH] Update README.md to match dogapparel mod and fix typos Fixed typo a ungoing --> an ongoing. Copied, pasted the FAQ from DogApparel readme to match the mod template. Edited the first line under description: ```Rimworld mod template, select this repo at the start of making your mod. Don't forget to fill in your own your metadata in the about.xml, as well to make your own readme. This is just an example.``` added blank line at the bottom of the readme. Signed-off-by: Chunnyluny <102756485+Chunnyluny@users.noreply.github.com> --- README.md | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index a0e3b02..1e64b58 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,15 @@ # RimWorldMod, a RimWorld mod template -

Built for RimWorld   - + GitHub   -GitHub issues +GitHub issues   @@ -20,46 +19,45 @@ Buy me a coffee -

--- ## Description -```Rimworld mod template including About.xml, readme.md. For personal use, Copy the files, and select this as template, when making another mod.``` +```Rimworld mod template, select this repo at the start of making your mod. Don't forget to fill in your own your metadata in the about.xml, as well to make your own readme. This is just an example.``` *Hey there, fellow RimWorld enthusiasts! I'm the creator behind the X mod!* *RimWorldMod brings some awesome new stuff to [RimWorld mod](https://rimworldwiki.com/wiki/Mods) for the [Ludeon Studios](https://ludeon.com/) game [RimWorld](https://rimworldgame.com/). Please see the [Acknowledgement section](#acknowledgement) below for important information.* - --- ## FAQ -### Can I add this mod to a save game? +### Can I add this mod to an ongoing save game? -Yes. No problem. You need to enable the items first so the pawns can interact with them; be aware any mod that adds new items, such as food, drugs, and clothing, is automatically disabled in stockpiles. Colonists will ignore them, and they will not haul or wear the item. When you just added this mod, the items are not automatically included in the stockpiles or recipes. This is not considered a bug or an error. You just need to tick them on for recipes or stockpiles etc. After you enable them, they will show up. +Yes but you need to enable the items first, so the pawns can interact with them; be aware any mod that adds new items, such as food, drugs, and clothing, is automatically disabled in stockpiles. Colonists will ignore them, and they will not haul or wear the item. When you just added this mod, the items are not automatically included in the stockpiles or recipes. This is not considered a bug or an error. You just need to tick them on for recipes or stockpiles etc. After you enable them, they will show up. ### Can I remove this mod from a save game? -I wouldn't advise it, as a general rule. If you really want to, start by backing up your saves, then get rid of all the mod-added items in your game and make sure none of your pawns/colony animals are wearing any apparel. No apparel/items is made at the tailor table etc. Make sure they are not stored in stockpiles, and pawns are not training animals, cancel any research related to this mod. Then you can try removing the mod. But I can't promise to help you if this breaks your save. That's what the backup is for. +I wouldn't advise it, as a general rule. If you really want to, start by backing up your saves, then get rid of all the mod-added items in your game and make sure none of your pawns/colony animals are wearing any apparel. No apparel is made at the tailor table etc. Make sure they are not stored in stockpiles, and pawns are not training animals, cancel any research related to this mod. Then you can try removing the mod. But I can't promise to help you if this breaks your save. That's what the backup is for. -### Any requirements for this mod to work? -Yes, list the mods with their steamlinks, if not, you can puts mods as suggestions they would work together, make sure people know it is a choice not a musthave. +### Any requirement(s) for this mod to work? -It is recommmended to use a mod manager like [RimPy](https://github.com/rimpy-custom/RimPy/releases) or [RimSort](https://github.com/RimSort/RimSort) to install this mod. They are recommended and will help loading the mod in the correct order. These mod managers are more explained in details on my [Troubleshootingguide](https://github.com/Chunnyluny/troubleshootingguide/README.md). More information about this mod is found on [About.xml](DogApparel/About/About.xml) +Yes this mod is created to use the [Animal Gear](https://steamcommunity.com/workshop/filedetails/?id=1541438907). You should also use a mod manager like [RimPy](https://github.com/rimpy-custom/RimPy/releases) or [RimSort](https://github.com/RimSort/RimSort) +They make sure you load this mod in the right place. You can find more information about these mod managers in my [Troubleshooting Guide](https://github.com/Chunnyluny/troubleshootingguide/README.md). ### Combat Extended compatible? -Why wouldn't it be? I don't want to use [Combat Extended](https://github.com/CombatExtended-Continued/CombatExtended) because it doesn't work well with most of the mods I like. If you use Combat Extended and have info on mod compatibility, share your experience using both mods. +I have not made a patch to support Combat Extended, because I don't use [Combat Extended](https://github.com/CombatExtended-Continued/CombatExtended) myself. +If you use Combat Extended in your modlist and have more info about regarding the compatibility, please share your experience with both mods enabled. -### Can I use this mod with [any other mods]? +### Can I use this mod with any other mod(s)? -Sure it will be possible. It's extremely unlikely for there to be any conflict between my mod and any other mod. If you do run into an incompatibility of any kind, though, feel free to [open an issue](https://github.com/Chunnyluny/RimWorldMod/issues/new) +You can try out for yourself, I have included textures, if you are using Vanilla Animals Expanded. I have checked before if there is any mod existing on the workshop that would would add the same items/features as my mod. I have not found anything similar, so I assume it is quite rare to get any mod conflict. ```Place the 'Animal Gear' mod before this mod in the load order for proper functionality.``` If you do run into an incompatibility of any kind, though, feel free to [open an issue](https://github.com/Chunnyluny/DogApparel/issues/new) -### Steam or GitHub? +### Steam or GitHub and when available for release? -This mod is still in development and will be pre-released on Github before it is available on the SteamWorkshop, since I don't own RimWorld on Steam I can't upload it to the RimWorld workshop page. +This mod is still in development and will be released on Github when it is almost content ready. Since this mod is a collab. it will be expanded upon. Because this is my first ever RimWorld mod, I appreciate any feedback or bugreports, you can place them in the [Issues tab](https://github.com/Chunnyluny/DogApparel/issues/new). I will prefer updating this mod on GitHub, since it is easier to implement new features and bugfixes through GitHub. When any Alpha version is ready to test out, feel free to star this repository to keep up-to-date and provide me with any feedback on functionality of this mod. ## Acknowledgement