Chummer XML Importer: Difference between revisions

Help

Latest revision as of 02:00, 27 December 2023

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.

Needs Improvement

The XML importer is not perfect. This function should be considered experimental and unstable.^{[git 1]}

This article was last edited Wednesday, December 27, 2023 by Mr. Johnson.

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 before being fully functional. Furthermore, it operates on the raw XML datafiles so it does not take into account any Custom Data Files configured in Chummer.

General Tips

Chummer XML Sources

XML	Item Types
`weapon.xml`	Weapons, some Gear Modifications
`armor.xml`	Armor, some Gear Modifications
`gear.xml`	Ammo, Devices, Equipment, and Programs
`spells.xml`	Spells and Rituals
`complexforms.xml`	Complex Forms
`qualities.xml`	Qualities
`cyberware.xml`	Cyberware
`bioware.xml`	Bioware
`critterpowers.xml`	Critter Powers

The importer is sensitive to the exact content of Chummer5a's XML files. Be sure to check the notes in the Chummer XML Import interface to make sure the data files used are compatible.^{[git 2]}
It neither checks for not overwrites duplicates. It imports everything in the XML file fresh every time.
Imported items are marked for review, as with the Chummer Character Importer.

How To Import Items

Chummer XML Importer (SR5 v0.16.1, FVTT v11.315)

Download and install Chummer5a.
Select the Item Directory in Foundry's sidebar.
Click Import Chummer Data at the bottom.
If you want the imported items in a language other than English, choose a translation file from the /lang subfolder in Chummer's installation directory.
Select the XML files to import from the /data subfolder. Only the files shown in the importer UI are compatible with the parser; other item types cannot be imported. You can select all the XML files in the file picker, but the incompatible ones will be ignored.
Select wether or not the default icons will be applied to imported items.
Press Import.

The selected files will be imported into Foundry's Items Directory, inside a folder named "SR5e". To reduce the download impact during user logins, it's best to move them to a Compendium.

Not Implemented

As of SR5 v0.16.1, all except three Item types that exist in Chummer are imported — Adept Powers^{[git 3]}, Echoes, and Metamagics are not yet available.

Other item types are not present in Chummer's XML files and will never be imported in bulk: Actions, Contacts, Hosts, Lifestyles, and Summon/Compile Items.

References

GitHub Issues

↑ The Importer Project gathers relevant issues.
↑ Issue #978
↑ Issue #504

[1] The Importer Project gathers relevant issues.

["978-2] Issue #978

["504-3] Issue #504

[git 1]

[git 2]

[git 3]

@@ Line 1: / Line 1: @@
 [[Category:Content]][[Category:Importer|XML]]The Chummer XML Importer allows the user to scrape [https://github.com/chummer5a/chummer5a Chummer5a]'s datafiles and bring them into Foundry as SR5 system-compatible {{Category|Item}}s for use on {{Category|Actor}}s.
-{{Needs Improvement|The XML importer is not perfect. This function should be considered experimental and unstable.}}
+{{Needs Improvement|The XML importer is not perfect. This function should be considered experimental and unstable.<ref group="git">The [https://github.com/users/SR5-FoundryVTT/projects/8 Importer Project] gathers relevant issues.</ref>}}
-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 before being fully functional. As it operates on the raw XML datafiles, it does not take into account any [https://github.com/chummer5a/chummer5a/wiki/Custom-Data-Files Custom Data Files] configured in Chummer.
+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 before being fully functional. Furthermore, it operates on the raw XML datafiles so it does not take into account any [https://github.com/chummer5a/chummer5a/wiki/Custom-Data-Files Custom Data Files] configured in Chummer.
-{{Imagebox|sr5-chummer-item-import.png|Chummer XML Importer|s=0.16.1|f=11.315}}
 ==General Tips==
-* The importer is sensitive to the exact content of Chummer5a's XML files. Be sure to check the notes in the Chummer XML Import interface to make sure the data files used are compatible.
+{{:Table:Chummer XML Sources}}
+* The importer is sensitive to the exact content of Chummer5a's XML files. Be sure to check the notes in the Chummer XML Import interface to make sure the data files used are compatible.{{Issue|978}}
 * It neither checks for not overwrites duplicates. It imports everything in the XML file fresh every time.
 * Imported items are [[Importer Review|marked for review]], as with the [[Chummer Character Importer]].
 ==How To Import Items==
+{{Imagebox|sr5-chummer-item-import.png|Chummer XML Importer|s=0.16.1|f=11.315}}
 # Download and install '''Chummer5a'''.
 # Select the '''Item Directory''' in Foundry's sidebar.
 # Click '''Import Chummer Data''' at the bottom.
 # If you want the imported items in a language other than English, choose a translation file from the {{Code|/lang}} subfolder in Chummer's installation directory.
-# Select the XML files to import from the {{Code|/data}} subfolder. Only the files shown in the importer UI are compatible with the parser; other item types cannot be imported.
+# Select the XML files to import from the {{Code|/data}} subfolder. Only the files shown in the importer UI are compatible with the parser; other item types cannot be imported. You can select all the XML files in the file picker, but the incompatible ones will be ignored.
 # Select wether or not the default icons will be applied to imported items.
 # Press '''Import'''.
-The selected files will be imported into Foundry's [https://foundryvtt.com/article/items/ Items Directory], inside a folder named "SR5e".
+The selected files will be imported into Foundry's [https://foundryvtt.com/article/items/ Items Directory], inside a folder named "SR5e". To reduce the download impact during  user logins, it's best to move them to a [https://foundryvtt.com/article/compendium/ Compendium].
 ==Not Implemented==
-Currently {{ver|0.16.1}}, all except three {{Category|Item}} types that exist in Chummer are imported &mdash; [[Adept Power Item|Adept Powers]], [[Echo Item|Echoes]], and [[Metamagic Item|Metamagics]] are not yet available.
+As of {{ver|0.16.1}}, all except three {{Category|Item}} types that exist in Chummer are imported &mdash; {{Item|Adept Power}}s{{Issue|504}}, {{Item|Echo|s}}, and {{Item|Metamagic}}s are not yet available.
 Other item types are not present in Chummer's XML files and will never be imported in bulk:
-[[Action Item|Actions]], [[Contact Item|Contacts]], [[Host Item|Hosts]], [[Lifestyle Item|Lifestyles]], and [[Summon/Compile Item]]s.
+{{Item|Action}}s, {{Item|Contact}}s, {{Item|Host}}s, {{Item|Lifestyle}}s, and [[Summon/Compile Item]]s.
 {{References}}