Queen's Brothel Mod (Template)

Standard project configuration template for (Queen's Brothel](https://queensbrothel.com/) mods.

This template is heavily based on the Example Mod repo with some modifications for portability.

Powered by Cookiecutter template engine, meant to be distributed with Cruft.

Usage

Besure to install cruft:

pip3 install cruft

Setup

In a new repository:

cruft create https://github.com/CodeZwei/cruft-qbmod/

In an existing repository:

# Link the repo to the bare template
cruft link https://github.com/CodeZwei/cruft-qbmod -c v0.0.0
# Update to desired release to apply all the changes
cruft update (-c v1.0.0)

Be sure to keep any project specific config changes.

Update

Check if there are updates upstream:

cruft check

Update to latest:

# Update to latest commit
cruft update
# Update to specific release tag
cruft update -c v1.1.0

Resolve merge conflicts, keeping project specific overrides and deletions.

Tools

• Yarn - Package Manager of choice for node modules
• ESLint - Pluggable lint for Javascript/TypeScript
• clang-format - Code Formatting library

CI

• GitHub Actions - CI Pipelines hosted by GitHub

Best Practices

• Keep-a-Changelog - Guide for maintaining a useful, readable Changelog.