Skip to content

Commit

Permalink
Bad target folder docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Noggog committed Jul 8, 2024
1 parent 9b02f7c commit 2c143ff
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/bad-target-folder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Bad Target Folder

"Cannot export next to a .git folder"

Spriggit's patterns require that you serialize into a folder that is wholly dedicated to containing Spriggit content. As part of the serialization process, all files within that folder that were not just exported get deleted. As such, if you're exporting spriggit content into a folder containing other files, they will be deleted as part of the serialization process.

## Solution

Simply make a new dedicated subfolder named after the mod and target that instead.

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

In this case, you would not want to target `/Some Folder`, as that has `Other Content.txt` within it. Rather, targeting a subfolder with nothing else is recommended.
3 changes: 3 additions & 0 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ This converts from a Bethesda Plugin mod to Yaml, and puts it in your Git Reposi
| `-t` | `--Threads` | Optional | Maximum number of threads to use |
| `-d` | `--Debug` | Optional | Set up for debug mode, including resetting nuget caches |

!!! error "Must Have Dedicated Folder"
Make sure the output path is pointed to a folder which is -wholly- dedicated to containing Spriggit content. [More Info](backups.md)

## Deserialize | Convert To Plugin
`deserialize`, `convert-to-plugin`, `create-plugin`

Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -63,4 +63,5 @@ nav:
- Troubleshooting:
- Backups: backups.md
- Unexpected Records: unexpected-records.md
- Bad Target Folder: bad-target-folder.md
- Backwards Compatibility With Alpha Versions: alpha-backwards-compatibility.md

0 comments on commit 2c143ff

Please sign in to comment.