Chummer XML Importer: Difference between revisions

Help

Revision as of 22:30, 15 July 2025

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 Tuesday, July 15, 2025 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 Items Directory in Foundry's sidebar in SR5 v0.26.0 or earlier, or the Compendium Packs Directory in SR5 v0.27.0 or later.
# Click Import Chummer Data at the bottom.
If you're using SR5 v0.27.0 or later, you have the option of Advanced Mode or "Quick Import Data".
- For Quick Import, simply hit the button and let it do it's thing — it will take some time, but you can monitor the progress.
- For Advanced Mode (or in prior versions), continue...
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 10: / Line 10: @@
 ==How To Import Items==
 {{Imagebox|sr5-chummer-item-import.png|Chummer XML Importer|s=0.16.1|f=11.315}}
-# Download and install '''Chummer5a'''.
+<ol>
-# Select the '''Items Directory''' in Foundry's sidebar in {{ver|0.26.0|s}} or earlier, or the '''Compendium Packs Directory''' in {{ver|0.27.0}} or later.
+<li>Download and install '''Chummer5a'''.</li>
-# Click '''Import Chummer Data''' at the bottom.
+<li>Select the '''Items Directory''' in Foundry's sidebar in {{ver|0.26.0|s}} or earlier, or the '''Compendium Packs Directory''' in {{ver|0.27.0}} or later.</li>
-# If you're using {{ver|0.27.0}} or later, you have the option of Advanced Mode or "Quick Import Data".
+<li># Click '''Import Chummer Data''' at the bottom.</li>
-** For Quick Import, simply hit the button and let it do it's thing &mdash; it will take some time, but you can monitor the progress.
+<li>If you're using {{ver|0.27.0}} or later, you have the option of Advanced Mode or "Quick Import Data".
-** For Advanced Mode (or in prior versions), continue...
+<ul><li>For Quick Import, simply hit the button and let it do it's thing &mdash; it will take some time, but you can monitor the progress.</li>
-# 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.
+<li>For Advanced Mode (or in prior versions), continue...</li></ul></li>
-# 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.
+<li>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.</li>
-# Select wether or not the default icons will be applied to imported items.
+<li>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.</li>
-# Press '''Import'''.
+<li>Select wether or not the default icons will be applied to imported items.</li>
+<li>Press '''Import'''.</li>
+</ol>
 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].