#Chummer XML Importer

1 messages · Page 1 of 1 (latest)

fresh token
#

I'm working on the new documentation wiki, and just grabbed the old instructions for the XML data importer to start from.

http://sr5-foundryvtt.privateworks.com/index.php/Chummer_XML_Importer

Chummer XML Importer

The Chummer XML Importer allows the user to scrape Chummer5a's datafiles and bring them into Foundry as SR5 system-compatible Items for use on Actors.
Keep in mind that it is a bulk import and unfiltered, so it can produce hundreds or thousands of Items, some of which may never actually be used, and all of which will need to be manually reviewed...

#

The instructions are pretty thin, so if whomeve ris working on it has an details they think should be added, here's the place to let me know.

#

@wind epoch, somebody else was doing the bulk of the work here, right? Can you ping the appropriate person.

native edge
#

I think that’s me, unless someone else is also working on it. I’ll try to take a look sometime soon

native edge
#

Some initial notes below. Will add more if I think of any.

  1. Not all item types in the system are yet importable with the bulk importer (echoes, metamagic in particular)
  2. We should note that files go into a folder called Sr5e in the item tab
  3. The bulk importer doesn’t overwrite any items, it creates duplicates in the same folders if used multiple times (need to confirm tomorrow but I’m 90% sure on this)
  4. Items imported with the bulk importer are marked as needing review, the same as on characters
  5. Only the files from the latest stable release of Chummer are supported (5.225 in this case)
fresh token
#

That's all good to know (and document)!

native edge
#

No problemo!

#

Thanks for writing it up. It’ll be nice to have more complete info on the wiki

fresh token
#

@native edge, the Foundry UI makes a statement about the version of Chummer that's compatible. Generally speaking, Chummer updates are about the code, not the XML data. There are XML updates from time to time, but they're usually errata or data entry mistake corrections. I think the actual XML format is pretty well solidified. Do we actually need that caveat?

native edge
#

I think it's good to mention it still. There are issues that sometimes occur as the xmls change, I know there was at least one difference between 5.224 and 5.225 that caused the importer to not function on the nightly builds.

fresh token
#

Sounds good to me. I just wanted to confirm it was an actual problem, not a boogeyman. 👍

native edge
#

It might be even better to direct people to the appropriate release with a link (unless direct links are out for any reason). If you aren't familiar with github and how the release system works, it looks like the main page (https://github.com/chummer5a/chummer5a) is where you should be searching for the files, as the folder structure is right there in your face, but the Releases is a tiny little section off to the right and that's where you actually need to go.

native edge
fresh token
#

I don't know that I want to be that specific in the wiki, mostly so I don't have to update it... but linking to the proper release might be a good idea for inside the UI window in Foundry. That way, if a Chummer code change drives a new requirement, it can be updated in Foundry as part of the same fix.

native edge
#

Like within the dialog that pops up and prompts you to upload files?

fresh token
#

Yeah. I'll mention it and say "read the window in Foundry".

#

I don't want to have to update screenshots and such unless something changes significantly.

native edge
#

Yep sounds good.

#

Are we allowed to link directly to the Chummer page within the system code re: licensing reasons?

fresh token
#

I don't see why not. It's just saying "see this other thing". It doesn't imply any connection to that thing.

#

@wind epoch might have a differing opinion.

native edge
#

Cool cool, just wanted confirmation before changing anything like that. Ideally in the future this would be updated to allow you to put in a URL where the files are available, checkbox the ones you want to import, and click go. I think licensing rules will determine whether or not that URL box can be pre-populated with a Chummer link by default.

fresh token
#

Well... I don't think we want to go that far. We don't want to be pulling directly from Chummer's repository.

#

We want each individual end user to have to go through the steps of downloading them manually, then uploading them from those downloads.

#

That makes a clean separation between providing the tools and providing the data.

fresh token
native edge
fresh token
native edge
#

Messing with compendiums via code is f***ing annoying, to say the least

fresh token
#

I wonder if there's any core functionality you can work with in v11. It has the ability to create a compendium module, after all.

#

It might have some features to work with at the world level, too.

native edge
#

Possibly, I'll have another look at some point over the holidays. If I do change anything, I'll be sure to send you some notes for a wiki update

fresh token
#

Give the current version a read.

Chummer XML Importer

The Chummer XML Importer allows the user to scrape Chummer5a's datafiles and bring them into Foundry as SR5 system-compatible Items for use on Actors.

Keep in mind that it is a bulk import and unfiltered, so it can produce hundreds or thousands of Items, some of which may never actually be used, and all of which will need to be manually reviewe...

native edge
#

Looks good to me!

fresh token
#

Excellent.

wind epoch
fresh token
#

@native edge... while I'm thinking of it, can you give Category:Item a look. It should include every item type implemented in the system. Even if I haven't written the page on it, the article exists.

#

Can you tell run down the list and tell me which ones are not supported in the XML importer as of v0.16.1?

native edge
#

There's no bulk import for

  1. Actions
  2. Adept Powers
  3. Contacts
  4. Echo
  5. Host
  6. Lifestyle
  7. Metamagic
  8. Summon/Compile
fresh token
#

Oh... that's not bad! Most of those aren't things that even exist in XML in the first place.

#

I think only Echoes and Metamagics are missing.

native edge
#

And Adept Powers

#

I'm not sure why adept powers have never been in there, they've been missing for a while. Echoes and Metamagic were only added in the last couple of weeks so they'll hopefully be on the to-do list soon

fresh token
#

From the importer interface, it looks like Sprite Powers are missing, too... or are they stored in critterpowers.xml?

native edge
#

Yep, they're in critterpowers.xml

#

Actually that might be good to note, which item types are contained in which xmls. At least for ones that aren't the same as the xml name

fresh token
#

Yup, and an opportunity to use the table template I built the other day. Are there any others that two item types are in the same XML? I suppose weapons and armor can both produce Gear Mod items?

native edge
#

There are definitely a couple, but I'll have to dig through some code and maybe run some tests to confirm which ones are where. Might have to do that later as I'm a bit busy tonight and with work until Friday.

fresh token
#

No problem! None of this is high priority. 🙂

native edge
#

I'll try and look into it more on the weekend, if I haven't given you an answer by Monday please poke me again to remind me, I might have forgotten haha

fresh token
#

I get that... I'm mostly posting stuff in here to get thoughts out while I have them, so they don't get lost amongst all the other shit in my brain. 🙂

native edge
#

Yep yep, makes sense lol

fresh token
#

Off the top of your head, do you know if Ammunition comes out of weapon.xml or gear.xml? If not, no biggie.

native edge
#

Sorry missed this! It’s from gear, I believe

wind epoch