Vellum
Explore the screenshots »

Report a Bug · Request a Feature · Ask a Question · Read the Wiki

Table of Contents

• About
• Getting Started
  • Prerequisites
  • Installation
• Usage
  • Installing the source of a mod made using this template
  • Compiling your source
  • Preparing your source for a commit
  • Creating a new release
• Roadmap
• Support
• Project assistance
• Contributing
• Authors & contributors
• Security
• License
• Acknowledgements

---

About

A modernized template for Skyrim mods, built with out-of-the-box integrations with Caprica, Pyro, VSCode, Actions, and more. Download source code made with this template, and - with the right tools - you can get a working mod in less than a minute. Push a commit to your repository, and it'll give back a FOMOD installer ready for sharing. Make full use of GitHub's enterprise-tier source control features, and put it to work on your chores. This is modding dragged kicking and screaming into the century of the fruit bat. Screenshots GitHub Actions Automated Releases Pyro Remote Imports Prebuilt VSCode Tasks Automatic FOMOD Spriggified ESP

Built With

✒️papyrus-lang✒️
✒️Visual Studio Code✒️
🔧Caprica🔧
🔧Pyro🔧
🔧Spriggit🔧
🔧Mutagen🔧
📖amazing-github-template📖

Getting Started

Prerequisites

Tip

For more information, check out the wiki page on dependencies.

To use this template properly, you must have:

• The prerelease build of Caprica
• The prerelease build of the VSCode Papyrus extension
• The prerelease build of Pyro to replace the one in the extension's directory
• A GitHub account and a git installation
• The latest build of Spriggit
• Visual Studio Code and some basic extensions
• dotnet script and its dependencies (optional)

Installation

Tip

For more details, please see the wiki page on installation.

• Install all tools and dependencies
• Use Vellum as a template to create your own GitHub Repository.
• Clone it
• Delete sample project files
• Add your GitHub secrets token to Pyro
• Change settings.json
• Enable GitHub Actions (mandatory) and GitHub Discussions (optional)
• (Optional) Disable Mutagen scripts
• Update FOMOD's info.xml and ModuleConfig.xml with your project's details
• Adjust FOMOD to properly include your .esps and nothing else
• Adjust build script constants and FOMOD creation step
• Edit .gitignore

Note

You don't necessarily have to follow the below steps to craft your documentation. You can radically adjust this template as you see fit, or simply remake it from scratch.

You may find it helpful to consult this curated list of cool READMEs, this amazing template generator, and this video about designing a good README.

• Update documentation
  • Change all repository URLs. You should search and replace the whole repository, not just the README
  • Change my name and GH profile
  • Change Vellum to your project's name
  • Change screenshots and images to correspond to your mod
  • Add links to your socials and mod pages (e.g. Twitter, Nexus, Discord)
  • Rewrite About
  • Update Built With, Getting Started, Usage, Authors, and Acknowledgements
  • Update logos, screenshots, and any other supplementary resources
  • Amend the various GitHub templates (e.g. CONTRIBUTING.md, SECURITY.md, and CODE_OF_CONDUCT.md) as necessary. Most of the time, it shouldn't be.

Usage

Installing the source of a mod made using this template

1. Fork and clone the mod's repository
2. Install the Prerequisites
3. Run the Build All task
4. Ensure that mod has been properly prepared. This will include:
   1. No errors in the console
   2. All .esp plugins are in the root directory
   3. Scripts/ in root are filled with .pex files
   4. All files in dist have been copied into root (e.g. skse/, interface/)

Compiling your source

Just run Build All. That's it!

If you must perform other build tasks, add them to tasks.json and put them into Build All's dependsOn. Consider making a Pull Request for your new task to this template so other people can make use of it!

Preparing your source for a commit

Before you commit any code, make sure to run the Prepare Sources task. It's always a good idea to ensure on every commit that your code compiles and doesn't crash.

Creating a new release

Important

Consider using semantic versioning (e.g. v1.3.1) to name your release versions. It's standard industry practice for many good reasons.

Automated builds let you make releases quickly and often, and it's always a good idea to make your most recent changes as accessible as possible. You can generate a release through GitHub Actions:

1. In the Actions tab, select the Build Release workflow in the left pane
2. Click Run Workflow in the workflow runs table
3. Fill in your release version and turn on Publish Release?
4. Run the workflow and wait for it to finish
5. In the Releases section of your repository, find the newest release (it'll be a pre-release)
6. Edit the details as required
7. Un-check Set as pre-release and check Set as latest release

Roadmap

See the open issues for a list of proposed features (and known issues).

• Top Feature Requests (Add your votes using the 👍 reaction)
• Top Bugs (Add your votes using the 👍 reaction)
• Newest Bugs

Support

Reach out to the maintainer at one of the following places:

• GitHub Discussions
• Contact options listed on this GitHub profile
• Make a new issue

Project assistance

If you want to say thank you or/and support active development of Vellum:

• Add a GitHub Star to the project.
• Write interesting articles about the project on Dev.to, Medium or your personal blog.
• Spread the word on Bethesda modding discords and forums
• Use Vellum to make own mods! The more we stress-test this simple-looking template, the more robust and feature-rich we'll make it

Contributing

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

Authors & contributors

The original setup of this repository is by Daniil Zaikin.

For a full list of all authors and contributors, see the contributors page.

Security

Vellum follows good practices of security, but 100% security cannot be assured. Vellum is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the GNU General Public License v3.

See LICENSE for more information.

Acknowledgements

This would not have been possible without:

• 🏅dec0dOS, for making an 💎amazing-github-template
• 🏅Pickysaurus, for creating the inspiration of this template in the 💎Starfield build script
• 🏅joelday, for his years of work on the slick 💎VSCode papyrus-lang extension, not to mention 🏅everyone else
• 🏅nikitalita and 🏅Orvid for making the impossible possible with 💎Caprica
• 🏅fireundubh for forcing the future into the present with 💎Pyro
• 🏅sanjaysai for the cool, simple, and free 💎logo
• 🏅Noggog, for the indescribably useful 💎Spriggit and 💎Mutagen