Ludeon Forums

RimWorld => Mods => Help => Topic started by: Dingo on September 30, 2016, 12:51:41 AM

Title: [WIP] XML Documentation Database
Post by: Dingo on September 30, 2016, 12:51:41 AM
XML Documentation Database

RimWorldModdingFiles GitHub Repository (https://github.com/RimWorldMod/RimworldModdingFiles)

Description
This repository's goal is to make RimWorld modding easier. We strive to provide easy-to-read files to help everyone understand XML modding.

Feel free to use anything in the repository to help you make, update, modify or do anything relating to mods.

Folder structure

Contributing
Any contributions are welcome. These are some things we would love to see from other people:

Credits
Title: Re: [WIP] XML Documentation Database
Post by: kaptain_kavern on September 30, 2016, 02:59:41 AM
I will contribute more as soon as I have much more free time, Thanks for your efforts
Title: Re: [WIP] XML Documentation Database
Post by: Dingo on October 03, 2016, 08:49:22 PM
I think I got all of the easy defs so the project will probably slow down. Would appreciate help from some experienced modders in correcting what I already have in the fork.
Title: Re: [WIP] XML Documentation Database
Post by: kaptain_kavern on October 07, 2016, 02:16:05 PM
Can we please have a sticky on this one, dear mods?

Title: Re: [WIP] XML Documentation Database
Post by: Nimrod on October 13, 2016, 07:30:31 AM
This is very helpful! Thanks.

Also this needs to be sticky. :)
Title: Re: [WIP] XML Documentation Database
Post by: QuantumX on October 13, 2016, 09:48:10 AM
Love this, such good work...

Please do FactionDef, PawnKinds and NameMakerDef soon...

+1 for a sticky...
Title: Re: [WIP] XML Documentation Database
Post by: skullywag on October 16, 2016, 11:40:11 AM
Give me an S
Give me a T
Give me an I
Give me a C
Give me a K
Give me a Y
GOOOOOOOO STICKY!
Title: Re: [WIP] XML Documentation Database
Post by: Nimrod on October 20, 2016, 02:08:54 AM
If you could do HediffDef, I would be MUCH obliged! :)

cheers!
Title: Re: [WIP] XML Documentation Database
Post by: Dingo on October 26, 2016, 07:38:25 AM
If you could do HediffDef, I would be MUCH obliged! :)

cheers!

tl;dr Everything is optional. (https://github.com/RimWorldMod/RimworldModdingFiles/blob/master/Defs/HediffDefs/Hediffs.xml)
Title: Re: [WIP] XML Documentation Database
Post by: donoya on December 15, 2016, 12:09:13 PM
Hello, I'm just starting on my first mod and need documentation on the 'ThingDefs' files, which I've noticed is missing in your database. How soon do you think you'll add that to your database? I'm not necessarily looking for a set day, week, month, or even year (although it would be nice to know), but am rather looking for a generalized description (i.e. soon, not for a while, probably never, etc.). Thanks and keep up the good work.
Title: Re: [WIP] XML Documentation Database
Post by: Dingo on December 15, 2016, 07:02:38 PM
I'm no longer actively maintaining the repo. If anyone wants to contribute we will accept pull requests.

ThingDefs in particular I will probably never do because of the sheer amount of defs. HeDiffs took long enough..
Title: Re: [WIP] XML Documentation Database
Post by: faltonico on December 29, 2016, 04:12:00 AM
I hope you don't mind me asking a  couple questions here, i can't find the answer to it in the database as of now.
┬┐What does <MedicalTendQualityOffset> and <Bed_HealTickInterval> do? they used to have other names but were changed in A16.
More of them both means better treatment quality or outcome or both?
Title: Re: [WIP] XML Documentation Database
Post by: AngleWyrm on April 06, 2017, 02:34:58 PM
(https://s-media-cache-ak0.pinimg.com/564x/16/22/3b/16223b1111cc20439ed043d7876399b4.jpg)Thanks for this, it's been helpful!

A couple questions:
  • Is the range on commonality [0..2]? I thought it would be a probability of (0..1)
  • commonality seems to be different between single and spectrum records
    • In single records it's a fractional float
    • In spectrum records it seems like it's fixed to the value 1
  • Is that difference related to sub-commonality?
Title: Re: [WIP] XML Documentation Database
Post by: The-Eroks on April 12, 2017, 08:58:58 PM
Hmm and for the past month I've just been winging it... ;D maybe I should have looked at the help forum more closely.

I'll definitely update with whatever fun facts or knowledge I've gained and is not yet added.
Title: Re: [WIP] XML Documentation Database
Post by: dataframe on July 16, 2018, 08:50:51 AM
This is a great idea, it really helped me to get more into mod development - thank you!