Skip to content

Commit

Permalink
Unexpected record docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Noggog committed May 23, 2024
1 parent ff21906 commit 9f0f89a
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
21 changes: 21 additions & 0 deletions docs/unexpected-records.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Unexpected Records

Especially in the early days of a new game, you might see Spriggit refuse to serialize a mod with the verbage of "unexpected records".

This is intentional as a safety mechanism to help avoid data loss. If Spriggit encounters a record that it is unsure of, it refuses to proceed, rather than skip the record.

## Solution

Running into this error usually means that Spriggit's definitions need to be updated. You can report unexpected records to the [Spriggit](https://github.com/Mutagen-Modding/Spriggit/issues) or [Mutagen](https://github.com/Mutagen-Modding/Mutagen/issues) Github issues.

Please include as much detail as you can in the report, including:

- The subrecord in question that it complained about (usually printed in the logs or console)
- Information about what tools went into making the mod. Did you just use the official CK? Or did you use other 3rd party tools?
- The source file (if you're willing to give it)

With that info, Spriggit's definitions should hopefully get updated quickly in a new published version, and you'll be on your way. The mechanisms are meant to be upgraded frequently in this way.

Feel free to stop by the Discord to chat more directly!

[![Discord](https://discordapp.com/api/guilds/759302581448474626/widget.png)](https://discord.gg/53KMEsW)
6 changes: 4 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,11 @@ nav:
- Overview: index.md
- Workflow: workflow.md
- Output: output.md
- Installlation: installation.md
- Installation: installation.md
- Command Line Interface: cli.md
- .spriggit File: spriggit-file.md
- Translation Packages: translation-packages.md
- Merge Conflicts: merge-conflicts.md
- Backups: backups.md
- Troubleshooting:
- Backups: backups.md
- Unexpected Records: unexpected-records.md

0 comments on commit 9f0f89a

Please sign in to comment.