Ludeon Forums

Ludeon Forums

  • November 15, 2019, 07:47:11 AM
  • Welcome, Guest
Please login or register.

Login with username, password and session length
Advanced search  
Pages: [1] 2 3 ... 5

Author Topic: XML Auto-Documentation  (Read 40954 times)

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
XML Auto-Documentation
« on: July 15, 2016, 02:55:38 PM »

RimWorld XML Auto-Documentation

Version: 1.0



Download from Dropbox


Note: Due to IRL constraints, this is the last update I'll provide.  But since it's 1.0, I expect there won't be anymore major releases.



About

In case you're not sure what it is, this is an HTML help file for modders. It contains a listing of all Core (ie. vanilla) uses of RimWorld's XML code.  It's great for learning what tags are parents or children of what.  It's not necessarily exhaustive since the game engine may support options that aren't actually used by the base game.  I'm purposefully confining this to XML only.  I don't get into DLL modding, but anyone else is more than welcome to do that if they see fit.

As an additional feature, I track the grandparent/grandchild relationship for some of the common XML tags.  They're listed as SOME_TAG<SOME_CHILD>, which should be clear enough on its own but I'm always open to suggestions/requests.  I've also begun tracking tags with a CompProperties_ attribute separately, as they're handled separately.  The tags currently given special attention are:
  • li
  • defName
  • all tags with a CompProperties_ attribute

Feel free to request others to be tracked separately as you see the need.
Enjoy!



Auto-Doc Tool
For anyone who cares, I wrote the tool in a Windows-only language called AutoIt.  It should be compatible with Wine or ReactOS for any non-Windows users.  It's kinda inefficient, but it's what I was familiar with at the time and it gets the job done.
Link: https://www.dropbox.com/s/9aywpn55k5m728n/XML%20Auto-Doc.au3?dl=0


Old Stuff

Archive:
Beta 19: https://www.dropbox.com/s/qumdcbalw7fuwkm/CoreXML%20B19.html?dl=0
Beta 18: https://www.dropbox.com/s/nrwtwtzh706oouw/CoreXML%20A18.html?dl=0
Alpha 17: https://www.dropbox.com/s/dgh9pzv3o1jy98p/CoreXML%20A17.html?dl=0
Alpha 16: https://www.dropbox.com/s/a68vmnbpj8tr3vm/CoreXML%20A16.html?dl=0
Alpha 15: https://www.dropbox.com/s/5su98l69qn7j19e/CoreXML%20A15.html?dl=0
Alpha 14: https://www.dropbox.com/s/l9y2orqyszrrcrv/CoreXML%20A14.html?dl=0
Alpha 13: https://www.dropbox.com/s/jeysicdh1tjutf6/CoreXML%20A13.html?dl=0

New Modding Features
See the new A17 modding features here:
https://ludeon.com/forums/index.php?topic=32735.0

Patch Modding
Zhentar has made guide covering the new Patch process. Read about it here:
https://gist.github.com/Zhentar/4a1b71cea45b9337f70b30a21d868782

xpath troubleshooting
Skullywag is running an xpath clinic at this thread:
https://ludeon.com/forums/index.php?topic=33186.0

Modder's Guide to Abstracts (obsolete, but link kept for historical purposes):
https://ludeon.com/forums/index.php?topic=19499.0
« Last Edit: May 07, 2019, 07:30:12 AM by milon »
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: [A14] XML Auto-Documentation
« Reply #1 on: July 16, 2016, 08:51:13 AM »

Thx  8)

Asero

  • Drifter
  • **
  • Posts: 95
  • Muffalo Herder
    • View Profile
Re: [A14] XML Auto-Documentation
« Reply #2 on: July 16, 2016, 09:39:23 PM »

Very useful, thanks  ;D
Logged

Man_Jones

  • Drifter
  • **
  • Posts: 53
  • Refugee
    • View Profile
Re: [A14] XML Auto-Documentation
« Reply #3 on: July 16, 2016, 10:47:52 PM »

Pardon me for being a noob on these forums but what is this for?
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: [A14] XML Auto-Documentation
« Reply #4 on: July 17, 2016, 12:15:49 AM »

It's for modding purpose. It's a list of all the tags and the parameter that they can take

kaptain_kavern

  • Planetologist
  • ****
  • Posts: 2074
  • started 10 mods in one tick.
    • View Profile
    • RimWorldMod Slack - A place for live chatting about RimWorld modding
Re: [A14] XML Auto-Documentation
« Reply #5 on: July 21, 2016, 02:35:37 PM »

[BUMP]

Just because this should already been stickied :p

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A14] XML Auto-Documentation
« Reply #6 on: July 24, 2016, 09:34:12 AM »

I'll sticky it.  It always feels a little pretentious to sticky my own thread, but if someone else wants it stickied that's different, right?  ;)

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A14] XML Auto-Documentation
« Reply #7 on: July 28, 2016, 02:32:21 PM »

I just realized this morning that the reference I had online was for A14a.  It's now updated to A14d.  As a bonus, defName is now linked to its parent just like li.

kaptain_kavern

  • Planetologist
  • ****
  • Posts: 2074
  • started 10 mods in one tick.
    • View Profile
    • RimWorldMod Slack - A place for live chatting about RimWorld modding
Re: [A14] XML Auto-Documentation
« Reply #8 on: July 28, 2016, 02:53:49 PM »

Your my hero <3

srauon

  • Muffalo
  • *
  • Posts: 9
  • teh drk lard
    • View Profile
Re: [A14] XML Auto-Documentation
« Reply #9 on: August 01, 2016, 07:03:58 AM »

The documentations are incredibly helpful. Thanks for posting it, Milon!  ;D
Logged

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A14] XML Auto-Documentation
« Reply #10 on: August 02, 2016, 12:22:08 PM »

Welcome!  And this is for A14E build 1249 now.  I put that in my sig but forgot to update this page.  ^_^

kaptain_kavern

  • Planetologist
  • ****
  • Posts: 2074
  • started 10 mods in one tick.
    • View Profile
    • RimWorldMod Slack - A place for live chatting about RimWorld modding
Re: [A14] XML Auto-Documentation A14e build 1249
« Reply #11 on: August 02, 2016, 06:11:41 PM »

I know i don't have to bump up the post anymore but again thank you ;)

Can i ask you which tool you use to generate/compile this please ?

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A14] XML Auto-Documentation A14e build 1249
« Reply #12 on: August 04, 2016, 11:15:17 AM »

Just a script I wrote myself.  I did it in AutoIt (www.autoitscript.com) if you care.  And I can post it if you or anyone else is interested.

Jdalt40

  • Colonist
  • ***
  • Posts: 323
  • Raiderpede Demigod
    • View Profile
Re: [A14] XML Auto-Documentation A14e build 1249
« Reply #13 on: August 05, 2016, 10:07:52 PM »

Sorry if this is not where I should ask this, but what is 'HediffComp_VerbGiver'.
I just need to know because I need to set a Comp for my new Hediff :)
Logged

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A14] XML Auto-Documentation A14e build 1249
« Reply #14 on: August 10, 2016, 12:19:35 PM »

Hey, just saw your post.

See an example of it in ...\Mods\Core\Defs\HediffDefs\Hediffs_Local_AddedParts.xml

It goes in a <HediffDef> block (which modifies Health and related effecets) and is responsible for giving Verbs (attack options) to pawns.  In vanilla, this applies to the BionicArm, PowerClaw, and ScytherBlade.
Pages: [1] 2 3 ... 5