Ludeon Forums

Ludeon Forums

  • December 13, 2019, 05:39:25 AM
  • Welcome, Guest
Please login or register.

Login with username, password and session length
Advanced search  

Author Topic: [WIP] XML Documentation Database  (Read 8727 times)

Dingo

  • Colonist
  • ***
  • Posts: 513
  • Mod Author
    • View Profile
    • Steam Profile
[WIP] XML Documentation Database
« on: September 30, 2016, 12:51:41 AM »

XML Documentation Database


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
  • One master file per folder (ex. Recipes.xml) containing a very long XML def. Every line is commented to explain what it does.
  • One templates file per folder (Templates.txt) containing a few easy-to-copy defs without comments.
  • One examples file per folder (Examples.xml) containing several complete defs (taken from vanilla and/or mods).

Contributing
Any contributions are welcome. These are some things we would love to see from other people:
  • New master XML files
  • Corrections to mistakes in existing files
  • New templates
  • New, useful examples (including from well-structured mods)
  • Suggestions & questions

Credits
  • kaptain_kavern for creating the original repo
  • milon for his extremely useful XML auto-documentation
  • Zhentar for his fork of ILSpy which has been very invaluable
« Last Edit: October 28, 2016, 04:49:19 PM by Dingo »
Logged

kaptain_kavern

  • Planetologist
  • ****
  • Posts: 2074
  • started 10 mods in one tick.
    • View Profile
    • RimWorldMod Slack - A place for live chatting about RimWorld modding
Re: [WIP] XML Documentation Database
« Reply #1 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

Dingo

  • Colonist
  • ***
  • Posts: 513
  • Mod Author
    • View Profile
    • Steam Profile
Re: [WIP] XML Documentation Database
« Reply #2 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.

kaptain_kavern

  • Planetologist
  • ****
  • Posts: 2074
  • started 10 mods in one tick.
    • View Profile
    • RimWorldMod Slack - A place for live chatting about RimWorld modding
Re: [WIP] XML Documentation Database
« Reply #3 on: October 07, 2016, 02:16:05 PM »

Can we please have a sticky on this one, dear mods?

Nimrod

  • Drifter
  • **
  • Posts: 74
  • Refugee
    • View Profile
Re: [WIP] XML Documentation Database
« Reply #4 on: October 13, 2016, 07:30:31 AM »

This is very helpful! Thanks.

Also this needs to be sticky. :)
Logged

QuantumX

  • Drifter
  • **
  • Posts: 92
  • Refugee
    • View Profile
Re: [WIP] XML Documentation Database
« Reply #5 on: October 13, 2016, 09:48:10 AM »

Love this, such good work...

Please do FactionDef, PawnKinds and NameMakerDef soon...

+1 for a sticky...
Logged

skullywag

  • Global Moderator
  • Transcendent
  • ****
  • Posts: 5857
  • Engineer
    • View Profile
Re: [WIP] XML Documentation Database
« Reply #6 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!
Logged
Skullywag modded to death.
I'd never met an iterator I liked....until Zhentar saved me.
Why Unity5, WHY do you forsake me?

Nimrod

  • Drifter
  • **
  • Posts: 74
  • Refugee
    • View Profile
Re: [WIP] XML Documentation Database
« Reply #7 on: October 20, 2016, 02:08:54 AM »

If you could do HediffDef, I would be MUCH obliged! :)

cheers!
Logged

Dingo

  • Colonist
  • ***
  • Posts: 513
  • Mod Author
    • View Profile
    • Steam Profile
Re: [WIP] XML Documentation Database
« Reply #8 on: October 26, 2016, 07:38:25 AM »

If you could do HediffDef, I would be MUCH obliged! :)

cheers!

tl;dr Everything is optional.

donoya

  • Drifter
  • **
  • Posts: 39
  • Refugee
    • View Profile
Re: [WIP] XML Documentation Database
« Reply #9 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.
Logged

Dingo

  • Colonist
  • ***
  • Posts: 513
  • Mod Author
    • View Profile
    • Steam Profile
Re: [WIP] XML Documentation Database
« Reply #10 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..

faltonico

  • Guest
Re: [WIP] XML Documentation Database
« Reply #11 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?
Logged

AngleWyrm

  • Planetologist
  • ****
  • Posts: 1154
  • Refugee
    • View Profile
Re: [WIP] XML Documentation Database
« Reply #12 on: April 06, 2017, 02:34:58 PM »

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?
« Last Edit: April 06, 2017, 04:11:18 PM by AngleWyrm »
Logged
My 5-point rating system: Yay, Kay, Meh, Erm, Bleh

The-Eroks

  • Colonist
  • ***
  • Posts: 200
  • Loremaster
    • View Profile
Re: [WIP] XML Documentation Database
« Reply #13 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.

dataframe

  • Muffalo
  • *
  • Posts: 1
    • View Profile
Re: [WIP] XML Documentation Database
« Reply #14 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!
Logged