This repository provides a standardized project structure and tooling to develop ESM, ESP and ESL plugins using plain text files. You can edit these files using a simple text editor or IDE, instead of specialized tools like xEdit.

Quickstart

To start off, click the "Use this template" button to create your own repository based on this one.

You can now customize this newly-generated repository for your mod.

1. Open the main source file, RecordData.yaml.
2. Change the value of the ModKey property to your plugin name.
3. Change the value of the Description property to your plugin description.
4. Change the value of the Author property to your plugin author name.

Developing your mod

This project comes pre-configured for local development with VS Code. You can also use this as a reference to configure your preferred IDE.

Spriggit is used for building the output plugin files for your mod. You will need to download and unzip the latest Spriggit.CLI.zip from the Releases page.

You will also need to change some additional settings:

1. Open the project-specific VS Code settings file, settings.json.
2. Change the value of the tools.spriggit.path property to your Spriggit CLI path (see the Tooling section).
3. Change the value of the tools.spriggit.compiled-plugin-name property to match your plugin name, as defined in the Quickstart section.

That's it! You are now ready to compile your mod.

1. Open the repository in VS Code.
2. Press Ctrl+Shift+B or navigate to Terminal > Run Build Task.
3. Select the Build Bethesda plugin from YAML task.
4. If everything is set up correctly, you will see a new plugin generated in the out/ directory. The plugin name will match what you configured above.
5. If there are any problems during compilation, a window will pop up showing the output and error messages from Spriggit.