Skip to content

Commit

Permalink
Update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Noggog committed Jan 15, 2025
1 parent 6637d42 commit 781ed31
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions docs/installation.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,27 @@
# Installation

## Install Latest .NET SDK
You can get the typical SDK installation from Microsoft's official page

[:octicons-arrow-right-24: Download SDK](https://dotnet.microsoft.com/download)

!!! tip "Restart"
It's usually a good idea to restart your computer after installing DotNet SDK to help things settle in.

This step is needed by the "engine" in order to download the Spriggit translation packages via `dotnet tool install`. [More info here](translation-packages.md).

## Download Spriggit Exe
Spriggit comes as a UI and a Command Line Interface. Both can be downloaded from the github releases page

[:octicons-arrow-right-24: Download](https://github.com/Mutagen-Modding/Spriggit/releases)

## Spriggit UI
### Spriggit UI
This is a self-contained WPF application, which can only run on Windows. You can add links between a mod file and where it should be translated to, and then sync back and forth with one click.

![Spriggit UI](images/spriggit-ui-1.png)
![Spriggit UI](images/spriggit-ui-2.png)

## Spriggit CLI
### Spriggit CLI
Spriggit comes with a Command Line Interface that can be used to convert from Betheseda Plugins to Git Repositories, and back.

!!! tip "UI Can Also Run as a CLI"
Expand Down

0 comments on commit 781ed31

Please sign in to comment.