https://github.com/szapp/patch-template

Initialize a new Gothic VDF patch right here on GitHub
https://github.com/szapp/patch-template

ci daedalus gothic gothic1 gothic2 initialization modding-gothic ninja template vdf

Last synced: 2 months ago
JSON representation

Initialize a new Gothic VDF patch right here on GitHub

• Host: GitHub
• URL: https://github.com/szapp/patch-template
• Owner: szapp
• License: mit
• Created: 2024-04-27T11:51:27.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-19T10:49:29.000Z (4 months ago)
• Last Synced: 2025-01-19T11:27:33.774Z (4 months ago)
• Topics: ci, daedalus, gothic, gothic1, gothic2, initialization, modding-gothic, ninja, template, vdf
• Homepage: https://ninja.szapp.de
• Size: 868 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# Patch Template

[![Coverage](.github/actions/initialization/badges/coverage.svg)](https://github.com/szapp/patch-template)

Initialize a new Gothic VDF patch right on here GitHub.

Generating a repository from this template will initialize a new Gothic VDF patch with the necessary file structure based on individual needs. 

It is helpful to get started with a new patch and ensures everything is setup right from the start with all the necessary checks and build scripts.

Let's get started!

## Create a patch

### 1️⃣ Generate a repository [from the template](https://repo.new/?template_name=patch-template&template_owner=szapp)

> Do not fork this repository, but generate from template!  

  [![Template](.github/actions/initialization/badges/template.png)](https://repo.new/?template_name=patch-template&template_owner=szapp)

### 2️⃣ In the new repo, open a [GitHub issue](../../issues/new/choose) to initialize the patch

> The generated repository's name and its description will serve as the name and description of the patch.

### 3️⃣ Wait for the initialization to complete

> Follow the next steps in the generated issue comments.

## Checks and continuous integration

The generated patch repository will be equipped with tests and continuous integration using the following GitHub Actions.

  

    

  [![szapp/parsiphae-action](https://img.shields.io/badge/szapp-parsiphae--action-34D058?logo=github&logoColor=959DA5&labelColor=444D56)](https://github.com/szapp/parsiphae-action)

    

  

  checks the Daedalus syntax on every commit.

  

  

    

  [![szapp/patch-validator](https://img.shields.io/badge/szapp-patch--validator-34D058?logo=github&logoColor=959DA5&labelColor=444D56)](https://github.com/szapp/patch-validator)

  

  

  checks the Daedalus symbols and resource file names on every commit.

  

  

  

  [![kirides/vdfsbuilder](https://img.shields.io/badge/kirides-vdfsbuilder-34D058?logo=github&logoColor=959DA5&labelColor=444D56)](https://github.com/kirides/vdfsbuilder)

  

  

  builds the patch into a ready to use VDF on every tag and release.

  

Creating a new tag or publishing a new release will trigger the `build` action that will create a VDF and attach it to the published release.

If Steam Workshop deployment is set up in the `build` action (`.github/workflows/build.yml`), the new version will be automatically published to the Steam Workshop.

The `build` action can also be triggered manually from the Actions menu and will provide the VDF as artifact of the latest commit to download.

## Documentation

For details on writing patches, please consult the [Ninja documentation](https://github.com/szapp/Ninja/wiki).

## Troubleshooting

In case the initialization does not start automatically after opening an issue in the generated repository, check the repository settings.

Actions and workflows should not be disabled. After enabling them create a new issue and try again.