Spriggit

https://mutagen-modding.github.io/Spriggit/
Admin
Spriggit is a tool designed to convert Bethesda plugin files into a text-based format, enabling mod...
Tokens:4,460
Snippets:70
Trust Score:9.7
Update:3 months ago
Show doc for...
Tokens:
Raw
### Example of a Dedicated Subfolder Structure

Source: https://mutagen-modding.github.io/Spriggit/bad-target-folder

Illustrates the recommended folder structure for exporting Spriggit content to avoid deleting existing files.

```text
/Some Folder
   Other Content.txt
   MyMod.esp/

```

--------------------------------

### Example Record Output in YAML

Source: https://mutagen-modding.github.io/Spriggit/output

This snippet shows the YAML representation of a game record, demonstrating how Spriggit formats plugin data for Git compatibility. It includes details like FormKey, EditorID, and model paths.

```yaml
FormKey: 087835:Skyrim.esm
EditorID: JewelryNecklaceGoldGems
ObjectBounds:
  First: -3, -9, 0
  Second: 3, 9, 1
Name: Gold Jeweled Necklace
WorldModel:
  Male:
    Model:
      File: Armor\AmuletsandRings\GoldAmuletGemsGO.nif
      Data: 0x020000000300000000000000A4E51E5364647300D8C674AFC031228D64647300D8C674AFB8EC307B64647300262C333B
PickUpSound: 08AB15:Immersive Sounds - Compendium.esp
PutDownSound: 08AB16:Immersive Sounds - Compendium.esp
Race: 013749:Skyrim.esm
Keywords:
- 06BBE9:Skyrim.esm
- 08F95A:Skyrim.esm
- 0A8664:Skyrim.esm
- 10CD0A:Skyrim.esm
Armature:
- 09171F:Skyrim.esm
Value: 485
Weight: 0.5

```

--------------------------------

### Mod Folder Structure for Spriggit

Source: https://mutagen-modding.github.io/Spriggit/output

This example illustrates how Spriggit organizes mod data into a folder structure, with separate files for different record types. This organization aids in managing Git diffs and understanding changes.

```plaintext
Some/Dedicated/Mod/Folder/  -  A folder dedicated to storing Spriggit content for a single mod
   RecordData.yaml          -  The mod header
   Weapons/                 -  Folder for all the weapons
      GlassDagger.yaml      -  File dedicated to the record Glass Dagger
      IronLongsword.yaml    -  Seperate file for the Iron Longsword
   Npcs/                    -  Folder for all the weapons
      Goblin.yaml           -  File dedicated to the Goblin's data

```

--------------------------------

### Basic .spriggit Configuration

Source: https://mutagen-modding.github.io/Spriggit/spriggit-file

Define the package name and release version for Spriggit translations. This file should be placed next to or above the Spriggit mod folder.

```json
{
  "PackageName": "Spriggit.Yaml",
  "Release": "Starfield",
  "Version": "0.18"
}
```

--------------------------------

### Convert Folder to Bethesda Plugin

Source: https://mutagen-modding.github.io/Spriggit/cli

Converts a folder in your Git Repository to a Bethesda Plugin. Use this to export your mod in a format compatible with the game.

```cli
.\Path\To\Spriggit.CLI.exe convert-to-plugin --InputPath "C:\Users\Levia\Downloads\SpriggitOutput\SomeMod.esp" --OutputPath "C:\MyGitRepository\SomeMod.esp"
```

--------------------------------

### Convert Bethesda Plugin to Git Repository (YAML)

Source: https://mutagen-modding.github.io/Spriggit/cli

Use this command to convert a Bethesda Plugin (.esp/.esm) into a YAML representation within a Git repository. Ensure the output path points to a dedicated folder for Spriggit content. The GameRelease and PackageName are required if a .spriggit file is not present.

```bash
.\Path\To\Spriggit.CLI.exe convert-from-plugin --InputPath "C:\Games\steamapps\common\Skyrim Special Edition\Data\SomeMod.esp" --OutputPath "C:\MyGitRepository\SomeMod.esp" --GameRelease SkyrimSE --PackageName Spriggit.Yaml
```

--------------------------------

### Review Changes with Git Diff

Source: https://mutagen-modding.github.io/Spriggit/upgrade-practices

After performing an upgrade or making other changes, use 'git diff' to review all modifications before committing. This helps identify unexpected changes.

```bash
git diff
```

--------------------------------

### Enable Long Paths Globally for Git

Source: https://mutagen-modding.github.io/Spriggit/filename-too-long

Run this command in your terminal to allow Git to handle paths longer than 260 characters on Windows. This is the recommended global solution.

```bash
git config --global core.longpaths true

```

--------------------------------

### Upgrade Spriggit Version via CLI

Source: https://mutagen-modding.github.io/Spriggit/upgrade-practices

Use the Spriggit CLI to upgrade a specified package to a new version. Ensure the path to the Spriggit CLI executable and the mod package are correct.

```bash
.\Path\To\Spriggit.CLI.exe upgrade -p "C:\MyGitRepository\SomeMod.esp\" -v "1.2.3"
```

--------------------------------

### Enable Long Paths for a Specific Git Repository

Source: https://mutagen-modding.github.io/Spriggit/filename-too-long

Execute this command from within a specific Git repository to enable long path support only for that project. Use this if you prefer per-repository configuration.

```bash
git config core.longpaths true

```

--------------------------------

### Commit Spriggit Upgrade Changes

Source: https://mutagen-modding.github.io/Spriggit/upgrade-practices

Stage all changes and commit them with a clear message indicating the Spriggit version upgrade. This should be done in a dedicated commit.

```bash
git add -A
git commit -m "Upgrade Spriggit to version 1.2.3"
```

--------------------------------

### Re-serialize Mod with New Spriggit Version via CLI

Source: https://mutagen-modding.github.io/Spriggit/upgrade-practices

Use the Spriggit CLI to re-serialize a mod file after updating the version in the meta file. This applies the new Spriggit version's changes to the mod.

```bash
.\Path\To\Spriggit.CLI.exe serialize -i "C:\Temp\SomeMod.esp" -o "C:\MyGitRepository\SomeMod.esp\"
```

--------------------------------

### Starfield Known Masters Configuration

Source: https://mutagen-modding.github.io/Spriggit/spriggit-file

Specify master files and their styles within a .spriggit file to provide necessary information for Starfield translations without requiring the actual master mod files. This is useful when running translations on a server.

```json
{
   "KnownMasters": 
   [
       {
           "ModKey": "Starfield.esm",
           "Style": "Full"
       }
   ]
}
```

--------------------------------

### Update Spriggit Version in Meta File

Source: https://mutagen-modding.github.io/Spriggit/upgrade-practices

Manually update the 'Version' field in the spriggit-meta.json file to reflect the new Spriggit version. This is part of the manual upgrade workflow.

```json
{
  "Source": {
    "PackageName": "Spriggit.Yaml.Skyrim",
    "Version": "1.2.3"
  }
}
```

--------------------------------

### Fix FormID Collisions

Source: https://mutagen-modding.github.io/Spriggit/cli

Use this command to resolve FormID collisions in your mod after a Git merge. Specify the path to your mod's plugin folder.

```bash
.\Path\To\Spriggit.CLI.exe formid-collision -p "C:\MyGitRepository\SomeMod.esp"
```
Tokens:
Raw