Ludeon Forums

Ludeon Forums

  • February 25, 2020, 09:40:12 AM
  • Welcome, Guest
Please login or register.

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

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

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A18] XML Auto-Documentation
« Reply #60 on: November 22, 2017, 06:59:05 PM »

I know it seems kinda nickpicky but it isnt A18 its B18 now.

Good catch, thanks. I'm about to leave town for US Thanksgiving, so I'll correct it after that if I don't forget. ;)

Heymom

  • Drifter
  • **
  • Posts: 91
  • Refugee
    • View Profile
Re: [A18] XML Auto-Documentation
« Reply #61 on: December 23, 2017, 04:06:34 AM »

How does this work? if i download the html page, its not translating the code. aka not much auto about it :D
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: [A18] XML Auto-Documentation
« Reply #62 on: December 23, 2017, 09:15:02 AM »

It's automatically made with a script, hence for the auto.

This is "just" a list of all XML tags used by the game

Heymom

  • Drifter
  • **
  • Posts: 91
  • Refugee
    • View Profile
Re: [A18] XML Auto-Documentation
« Reply #63 on: December 24, 2017, 10:37:00 AM »

It's automatically made with a script, hence for the auto.

This is "just" a list of all XML tags used by the game
Ahh, thought it was like a F1 ref. in compilers..
Logged

pliniojrm

  • Muffalo
  • *
  • Posts: 1
  • Refugee
    • View Profile
Re: [A18] XML Auto-Documentation
« Reply #64 on: February 26, 2018, 06:28:54 AM »

Hi quick question, because there is not in documentation:
What are values for <eType> ?
---Edit---
Nevermind it! But the XML Auto-Documentation A18 need a revision to add this:
List of <eType>:
Undefined, Pawn, Item, Chunk, Apparel, Equipment, Filth, Fire, Corpse, Puddle, DropPod, Medicine, Plant, Floor, Roof, Mote, Blueprint, Projectile, ItemSkyFalling, Ethereal, Rock, SteamGeyser, BuildingComplex, BuildingInert, Frame, Wall, Door, Bed, Building_Table, Building_PowerPlantGeothermal, Building_PowerConduit, Building_Battery, Building_ResearchBench, Building_Turret, Building_Chair, Building_Cryptosleepcasket, Building_TempController
« Last Edit: February 26, 2018, 09:16:56 AM by pliniojrm »
Logged

ilikegoodfood

  • Colonist
  • ***
  • Posts: 183
  • Mad Scientist
    • View Profile
Re: [A18] XML Auto-Documentation
« Reply #65 on: March 06, 2018, 07:21:22 AM »

Hi, this is a fantastic tool that I have only just started using, should probably have started with it earlier, and I had a thought...

I assume that this code is directed to the RimWorld Core folder and parses the information from the XML files.
Would it not be possible to target it to the RimWorld Mods folder and have it parse mods in addition to the Core folder?

I don't know how much work would be involved in that or how useful it would actually be, but I figured there was no harm in suggesting it.

Thank you for this fantastic tool.

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A18] XML Auto-Documentation
« Reply #66 on: March 08, 2018, 07:16:59 PM »

@pliniojrm, I'm back from my hiatus now. I'll look into that, thanks for the suggestion.

@ilikegoodfood, yes it's an automated tool that I made. It shouldn't be hard to point it at Core or even a specific mod, but that would only yield info about any mods I have installed. And I typically run less than half a dozen mods. I could release the tool, but it's Windows-only and I don't want to have to support it too, lol.

However, anyone who PM's me can get a copy of it for their own (unsupported) purposes.  ;)

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [A18] XML Auto-Documentation
« Reply #67 on: May 09, 2018, 06:23:23 PM »

Hi quick question, because there is not in documentation:
What are values for <eType> ?
---Edit---
Nevermind it! But the XML Auto-Documentation A18 need a revision to add this:
List of <eType>:
Undefined, Pawn, Item, Chunk, Apparel, Equipment, Filth, Fire, Corpse, Puddle, DropPod, Medicine, Plant, Floor, Roof, Mote, Blueprint, Projectile, ItemSkyFalling, Ethereal, Rock, SteamGeyser, BuildingComplex, BuildingInert, Frame, Wall, Door, Bed, Building_Table, Building_PowerPlantGeothermal, Building_PowerConduit, Building_Battery, Building_ResearchBench, Building_Turret, Building_Chair, Building_Cryptosleepcasket, Building_TempController

I'm finally working on this again. IRL has been incredibly hectic lately, and still kind of is.  ;)  Anyway, what version of RimWorld are you running?  There's no <eType> currently in it, there hasn't been for a long time.

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [1.0 Beta] XML Auto-Documentation
« Reply #68 on: July 13, 2018, 06:11:04 PM »

Oh, look!  An update!  :D
Public beta 1.0 is uploaded!
Find it in the first post.
« Last Edit: July 13, 2018, 06:12:39 PM by milon »
Logged

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [Beta 19] XML Auto-Documentation
« Reply #69 on: September 20, 2018, 09:14:31 AM »

Updated to public Beta 19

SickBoyWi

  • Drifter
  • **
  • Posts: 26
  • Refugee
    • View Profile
Re: [Beta 19] XML Auto-Documentation
« Reply #70 on: October 29, 2018, 01:01:42 PM »

This was insanely helpful! You have no idea. After searching for hours for an example of what I was trying to do, I finally decided to actually look up the XSD files. You are a life saver!
Logged

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [Beta 19] XML Auto-Documentation
« Reply #71 on: November 28, 2018, 05:21:21 PM »

Awesome! I'm glad to hear it! :D

TheMysticDreamer

  • Muffalo
  • *
  • Posts: 2
  • Refugee
    • View Profile
Re: [Beta 19] XML Auto-Documentation
« Reply #72 on: March 02, 2019, 06:18:23 PM »

Is this still accurate for 1.0?
Logged

milon

  • 100% Nerd*
  • Global Moderator
  • Transcendent
  • ****
  • Posts: 3584
  • * Conditions may apply
    • View Profile
Re: [Beta 19] XML Auto-Documentation
« Reply #73 on: May 06, 2019, 10:13:46 AM »

PM is better for me than a regular post.  I'm pretty much never around here anymore, mostly due to IRL stuff.

Anyway, I think Beta 19 was quite similar to 1.0, but maybe not 100%.  And I actually migrated from Windows to Linux several months ago, and totally forgot about this.  It's definitely a Windows-only tool, but when I have some time I'll use Wine or ReactOS to create an XML doc for 1.0.  I doubt I'll be supporting it beyond that, but the tool itself is still available for anyone who is interested.  (It's just an XML parser script for RimWorld.)

EDIT - I updated the OP to include a link to the tool itself, and the script language necessary to run it.

EDIT 2 - Updated again.  Version 1.0 is out.  Sorry for the delay!
« Last Edit: May 07, 2019, 07:31:00 AM by milon »
Logged

niciusb

  • Muffalo
  • *
  • Posts: 1
  • Refugee
    • View Profile
Re: XML Auto-Documentation
« Reply #74 on: October 19, 2019, 11:10:11 AM »

For anyone interested, I have recreated this project from scratch using nodejs, with many modifications.
In some ways it's better, in some worse. I have uploaded a version with the xml from the core 1.0 game: https://balbona.me/rimworld-data-extractor/core/ and another one using the Hardcore SK modpack: https://balbona.me/rimworld-data-extractor/hsk/
Ultimately, I would like to use it to generate auto-updating wikis of materials for construction, smithing, etc. But I don't understand enough about how the whole mod system works.

Check the github repo for the code, contributions welcome!
Logged
Pages: 1 ... 3 4 [5] 6