Anonymous
×
Create a new article
Write your page title here:
We currently have 55 articles on SR5 Foundry VTT System Wiki. Type your article name above or click on one of the titles below and start writing!



SR5 Foundry VTT System Wiki

Chummer Character Importer: Difference between revisions

m (Text replacement - "sample-" to "sr5-")
 
(25 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Content]][[Category:Importer|Character]]The SR5 system allows users to import characters from [https://github.com/chummer5a/chummer5a Chummer5a].
[[Category:Content]][[Category:Importer|Character]]The SR5 system allows users to import characters from [https://github.com/chummer5a/chummer5a Chummer5a]. It is primarily intended as a once-per-character activity; it is not intended for live synchronization. Re-importing will delete everything that hasn't be marked as updated or doesn't have an [[Active Effect]] built into it, and with no further warning.
{{Needs Improvement|date=false|Keep in mind that the character importer is not perfect. This function should be considered experimental and unstable.}}
{{Needs Improvement|Keep in mind that the character importer is not perfect. This function should be considered experimental and unstable.{{#vardefine:git|show}}<ref group="git">The [https://github.com/users/SR5-FoundryVTT/projects/8 Importer Project] gathers relevant issues.</ref>}}
==The Import Is Not Perfect==
* Do not import to an existing Character Actor without unchecking the appropriate boxes.
* The importer does not check to see if it's going to duplicate things. If you import twice you will have a lot of duplicates (like Items and Knowledge Kills) and will need to manually prune the duplicates.
* The importer only supports English at the moment. Attempting to import a character in any other langugage, will not import properly, including basic elements like attributes and skills.
==How To Import A Character==
==How To Import A Character==
{{Imagebox|sr5-chummer-character-import.png|Chummer Character Import Window|s=0.16.1|f=11.315}}The importer is found in the [[Character Actor#Misc Tab|Misc Tab]] of the [[Character Actor]] sheet. At this time {{ver|0.14.1}} it only works with characters, though it can import any vehicles the character has.
{{Imagebox|sr5-chummer-character-import.png|Chummer Character Import Window|s=0.16.1|f=11.315}}Starting from a previously-created [https://foundryvtt.com/article/actors/ Actor], the importer is found in the [[Character Actor#Misc Tab|Misc Tab]] of the [[Character Actor]] sheet. As of {{ver|0.16.1}}, it only works with characters, though it will also import any vehicles the character has.
# In Chummer, go to {{Code|Tools ¦ Global Settings ¦ Language}} and set it to "English (en-US)".
# In Chummer, go to {{Code|File ¦ Export}}.
# In Chummer, go to {{Code|File ¦ Export}}.
# In Chummer, click on the text to select it all (use CTRL+A if needed) and copy the text (CTRL+C). There is no need to save the file.
# In Chummer, click on the text to select it all (use {{key|CTRL}}+{{key|A}} if needed) and copy the text ({{key|CTRL}}+{{key|C}}). There is no need to save the file.
# In Foundry, create a new Character Actor or open an existing Character Actor. Navigate to the Misc Tab, and click '''Import Character''' button.
# In Foundry, create a new Character Actor then navigate to the {{Tab|Actor|Misc}}, and click '''Import Character''' button.
#* If this is the first time importing the character, it's safe to leave all the options selected.
#* If this is the first time importing the character, it's safe to leave all the options selected.
#* When attempting to update a character, be aware that duplicates can be generated. Uncheck things that have not be updated in Chummer and therefore should not be updated in Foundry.
#* When attempting to update a character (which is not advised), be aware that duplicates can be generated. Uncheck things that have not be updated in Chummer and therefore should not be updated in Foundry.
# Paste the text from Chummer into the Foundry text field and click the '''Submit''' button.
# Paste the text from Chummer into the Foundry text field and click the '''Submit''' button.


Line 18: Line 13:


==What Is Imported==
==What Is Imported==
The following things are imported:
The following things are imported, but should always be manually compared to the Chummer source character to confirm accuracy:
* Basic information (e.g. name, karma, nuyen, description)  
* Basic information (e.g. name, karma, nuyen, description)  
* Attributes and skills (action, knowledge and language skills)
* Physical, Mental, and Special Attributes
* Gear (weapons, armor, devices etc., however see below for more details)  
* Active Skills and Knowledge Skills (including Languages)
* Adept powers and spells
* Gear, including [[Weapon Item|Weapons]], [[Ammunition Item|Ammunition]], [[Armor Item|Armor]], [[Bioware Item|Bioware]][[Cyberware Item|Cyberware]], [[Device Item|Devices]], and [[Gear Modification Item|Gear Modifications]]. Generally speaking, only the very basics of the item are imported. Numerical attributes common to multiple item types (Rating, Quantity, Concealability, Cost, Availability, etc.) are included. The specifics of the item are not.
* Qualities, Contacts, Lifestyle
* Awakened properties, including [[Spell Item|Spells]], [[Ritual Item|Rituals]], [[Adept Power Item|Adept Powers]], [[Metamagic Item|Metamagics]], and Initiate Grade.
* Some modifiers like bonus initiative from cyberware, bonus to attributes from bioware etc.
* Emerged properties, including [[Complex Form Item|Complex Forms]], [[Echo Item|Echoes]], and Submersion Grade.
* [[Quality Item|Qualities]], [[Contact Item|Contacts]], [[Lifestyle Item|Lifestyles]], and [[SIN Item|SINs]]s.
 
==What Is Not Imported (or Imported Incorrectly)==
==What Is Not Imported (or Imported Incorrectly)==
The following things are NOT imported
The following things are not imported:
* Native Language Skills are imported, but they do not have any value nor any indication that they're special &mdash; they import without any rating at all.
* The properties from powers and implants are not included. The impact of them may be reflected in adjustements to the character's other properties, but they are not associated with any imported items.
** Attribute adjusments will show up directly calculated into the Attributes on the Character's [[Character Actor#Skills Tab|Skills Tab]].
** Initiative adjustments will show up on the Actor's [[Character Actor#Misc Tab|Misc Tab]].
** It may be desirable to revert them and instead implement them as [[Active Effect]]s on appropriate [[Item Sheet Basics|Items]].
* All kind of item mods. For example weapon accessories (e.g. smartgun system) or the installed mods in cyber eyes / limbs. The exception to this are armor mods.
* All kind of item mods. For example weapon accessories (e.g. smartgun system) or the installed mods in cyber eyes / limbs. The exception to this are armor mods.
* A lot of bonuses from adept powers / cyberware are not automatically applied.
* Bound Spirits
* Bound Spirits
* Alchemical Preparations
* Alchemical Preparations
* Limits are set to a fixed value on melee weapons
* Limits are set to a fixed value on melee weapons
* Mugshots
* Mugshots
* There are several things that the system does not yet support, e.g. like metamagic from initiation. Obviously this info is also not supported.
 
==What To Do After The Import==
==What To Do After The Import==
* Make sure that the bonuses from various sources like adept powers, cyberware etc. are applied correctly. The importer only does some basic things here. You can add various bonuses under the 'Misc' tab.
* Make sure that the bonuses from various sources like {{Item|Adept Power}}s, {{Item|Cyberware}}, etc. are applied correctly. The importer only pulls limited values. You can add various bonuses by adding [[Active Effect]]s to the appropriate [[:Category:Item|Items]].
* Manually add the things that are not imported, if you need them (see above). The item compendium can be useful for that.
* Manually add the things that are not imported, if you need them (see above). The item compendium can be useful for that.
* Equip / unequip the gear that you want. Most of the time chummer has everything marked as equipped, which is probably not what you want.
* Equip/unequip the appropriate gear. Most of the time Chummer has everything marked as equipped, which is probably not what you want.
{{References}}

Latest revision as of 15:43, 3 November 2024

The SR5 system allows users to import characters from Chummer5a. It is primarily intended as a once-per-character activity; it is not intended for live synchronization. Re-importing will delete everything that hasn't be marked as updated or doesn't have an Active Effect built into it, and with no further warning.

Needs Improvement
Keep in mind that the character importer is not perfect. This function should be considered experimental and unstable.[git 1]

This article was last edited Sunday, November 3, 2024 by Mr. Johnson.

How To Import A Character

Chummer Character Import Window (SR5 v0.16.1, FVTT v11.315)

Starting from a previously-created Actor, the importer is found in the Misc Tab of the Character Actor sheet. As of SR5 v0.16.1, it only works with characters, though it will also import any vehicles the character has.

  1. In Chummer, go to File ¦ Export.
  2. In Chummer, click on the text to select it all (use CTRL+A if needed) and copy the text (CTRL+C). There is no need to save the file.
  3. In Foundry, create a new Character Actor then navigate to the Actor's Misc Tab, and click Import Character button.
    • If this is the first time importing the character, it's safe to leave all the options selected.
    • When attempting to update a character (which is not advised), be aware that duplicates can be generated. Uncheck things that have not be updated in Chummer and therefore should not be updated in Foundry.
  4. Paste the text from Chummer into the Foundry text field and click the Submit button.

The import will execute and the Actor will be reflect the data from Chummer.

What Is Imported

The following things are imported, but should always be manually compared to the Chummer source character to confirm accuracy:

What Is Not Imported (or Imported Incorrectly)

The following things are not imported:

  • Native Language Skills are imported, but they do not have any value nor any indication that they're special — they import without any rating at all.
  • The properties from powers and implants are not included. The impact of them may be reflected in adjustements to the character's other properties, but they are not associated with any imported items.
    • Attribute adjusments will show up directly calculated into the Attributes on the Character's Skills Tab.
    • Initiative adjustments will show up on the Actor's Misc Tab.
    • It may be desirable to revert them and instead implement them as Active Effects on appropriate Items.
  • All kind of item mods. For example weapon accessories (e.g. smartgun system) or the installed mods in cyber eyes / limbs. The exception to this are armor mods.
  • Bound Spirits
  • Alchemical Preparations
  • Limits are set to a fixed value on melee weapons
  • Mugshots

What To Do After The Import

  • Make sure that the bonuses from various sources like Adept Powers, Cyberware, etc. are applied correctly. The importer only pulls limited values. You can add various bonuses by adding Active Effects to the appropriate Items.
  • Manually add the things that are not imported, if you need them (see above). The item compendium can be useful for that.
  • Equip/unequip the appropriate gear. Most of the time Chummer has everything marked as equipped, which is probably not what you want.

References

GitHub Issues

  1. The Importer Project gathers relevant issues.