Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
NotRyken committed Jul 2, 2024
0 parents commit 4839ca7
Show file tree
Hide file tree
Showing 8 changed files with 369 additions and 0 deletions.
105 changes: 105 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
name: Bug Report
description: "For reporting bugs and other defects"
labels:
- S/needs-triage
body:
- type: markdown
attributes:
value: >-
**This issue tracker is not intended for support requests!** Unless you are certain that
you have found a defect, and you are able to point to where the problem is, you should not
open an issue. For general support or if you're unsure, please ask on
[Discord](https://discord.terminalmc.dev).
Additionally, before you open a new issue:
- **Have you checked whether the issue has already been reported?** If it has been,
consider adding more information to the existing issue instead.
- **Have you determined the minimum set of instructions to reproduce the issue?** If the
problem only occurs with other mods installed, then you should attempt to narrow down
exactly which mods are causing it. Please do not provide your entire list of mods and
expect that we will be able to figure out the problem.
- type: input
id: mod-version
attributes:
label: Mod Version
description: >-
Specify the version(s) of the mod in which you have identified this issue.
**Example:** `v1.2.0-Fabric-1.20.6`
validations:
required: true
- type: input
id: mod-loader
attributes:
label: Mod Loader
description: >-
Specify the mod loader(s) in which you have identified this issue.
**Example:** `Fabric`
validations:
required: true
- type: input
id: mc-version
attributes:
label: Minecraft Version
description: >-
Specify the Minecraft version(s) in which you have identified this issue.
**Example:** `1.20.6`
validations:
required: true
- type: textarea
id: description
attributes:
label: Bug Description
description: >-
Describe in detail the issue you are experiencing, including the conditions in which it
occurs, and the names and versions of any other mods required to cause it.
**Hint:** If you have any screenshots, videos, or other information that you feel is
necessary to explain the issue, you can attach them here.
validations:
required: true
- type: input
id: expected-behavior
attributes:
label: Expected Behavior
description: >-
Describe what you believe should happen if the issue was fixed.
validations:
required: true
- type: textarea
id: reproduction-steps
attributes:
label: Reproduction Steps
description: >-
Describe the procedure required to reproduce this issue. Make sure your instructions are
as clear and concise as possible, as other people will have to follow your guide in order
to re-create the issue.
**Hint:** A common way to fill this section out is to write a step-by-step guide.
validations:
required: true
- type: textarea
id: log-file
attributes:
label: Log File
description: >-
**Hint:** Log files are located in the `logs` folder of your Minecraft instance, typically
`.minecraft/logs`. You will usually want the `latest.log` file, since that file belongs to
the most recent session of the game.
placeholder: >-
Drag-and-drop the log file here.
validations:
required: true
- type: textarea
id: crash-report-file
attributes:
label: Crash Report (optional)
description: >-
**Hint:** Crash reports are located in the `crash-reports` folder of your Minecraft instance,
typically `.minecraft/crash-reports`.
placeholder: >-
Drag-and-drop the crash report file here.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Support enquiry, Question or Discussion
url: https://discord.terminalmc.dev
about: For any issue that isn't specifically a bug report or feature request, please use Discord
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
name: Feature Request
description: "For requesting new features or improvements"
labels:
- S/needs-triage
- T/enhancement
body:
- type: markdown
attributes:
value: >-
This form is for requesting new features or improvements, and should not be used for bug
reports, port requests, or other issues. For general support or if you're unsure, please
ask on [Discord](https://discord.terminalmc.dev).
Before you open a new issue, please check to see if a similar request already exists
(either open or closed).
- type: textarea
id: description
attributes:
label: Request Description
description: >-
Describe the feature or improvement that you are looking for. The description should
explain what problem you are trying to solve, what alternatives you have considered, and
describe clearly and concisely what you would like changed.
115 changes: 115 additions & 0 deletions .github/labels.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
- name: E/duplicate
color: 'BFD4F2'
description: 'Closed: Same as another'
aliases: []

- name: E/external
color: 'BFD4F2'
description: 'Closed: External issue'
aliases: []

- name: E/invalid
color: 'BFD4F2'
description: 'Closed: Not an issue'
aliases: []

- name: E/no-action
color: 'BFD4F2'
description: 'Closed: Not actionable or inadequate information'
aliases: []

- name: E/wontfix
color: 'BFD4F2'
description: 'Closed: Will not be worked on'
aliases: []



- name: P/high
color: 'B60205'
description: 'Priority: High, for immediate attention'
aliases: []

- name: P/low
color: '006B75'
description: 'Priority: Low, not time-sensitive'
aliases: []

- name: P/medium
color: '36210B'
description: 'Priority: Medium, time-sensitive but not urgent'
aliases: []



- name: S/accepted
color: '0E8A16'
description: 'Status: Request accepted'
aliases: []

- name: S/available
color: '006B75'
description: 'Status: Available for community contribution'
aliases: []

- name: S/blocked
color: '97988B'
description: 'Status: Blocked by another event'
aliases: []

- name: S/fixed
color: '0E8A16'
description: 'Status: Fixed'
aliases: []

- name: S/info-needed
color: 'FBCA04'
description: 'Status: Awaiting further information'
aliases: []

- name: S/in-progress
color: '0052CC'
description: 'Status: Assigned and in progress'
aliases: []

- name: S/needs-triage
color: '36210B'
description: 'Status: Needs triage'
aliases: []



- name: T/addition
color: '006B75'
description: 'Type: New feature'
aliases: []

- name: T/bug
color: 'D93F0B'
description: 'Type: Bug'
aliases: []

- name: T/compat
color: '36210B'
description: 'Type: Compatibility'
aliases: []

- name: T/enhancement
color: '0052CC'
description: 'Type: Enhancement or optimization'
aliases: []

- name: T/fix
color: '0E8A16'
description: 'Type: Issue fix'
aliases: []

- name: T/port
color: '5319E7'
description: 'Type: Upgrade or downgrade game version'
aliases: []

- name: T/security
color: 'B60205'
description: 'Type: Security issue'
aliases: []
48 changes: 48 additions & 0 deletions .github/workflows/check-build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Builds the project on Linux and Windows as a partial defence against bad commits
name: Check Build

on:
push:
paths: [
'**src/**',
'**/*gradle*',
LICENSE
]
pull_request:
paths: [
'**src/**',
'**/*gradle*',
LICENSE
]
workflow_dispatch:

jobs:
build:
strategy:
matrix:
java: [21]
os: [ubuntu-latest, windows-latest]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Validate Gradle wrapper
uses: gradle/wrapper-validation-action@v3
- name: Setup JDK ${{ matrix.java }}
uses: actions/setup-java@v4
with:
distribution: zulu
java-version: ${{ matrix.java }}
- name: Make Gradle wrapper executable
if: ${{ runner.os != 'Windows' }}
run: chmod +x ./gradlew
- name: Build
run: ./gradlew build --stacktrace
- name: Capture build artifacts
if: ${{ runner.os == 'Linux' && matrix.java == '21' }}
uses: actions/upload-artifact@v4
with:
name: Artifacts
path: build/libs/
44 changes: 44 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Builds the project and publishes the artifacts to GitHub and Modrinth
# Requires GITHUB_TOKEN to have write permissions; if not, replace it with a custom token
# Requires a Modrinth PAT MODRINTH_TOKEN
name: Release

on: [workflow_dispatch]

permissions:
contents: write

jobs:
release:
strategy:
matrix:
java: [21]
os: [ubuntu-latest]
runs-on: ${{ matrix.os }}
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Validate Gradle wrapper
uses: gradle/wrapper-validation-action@v3
- name: Setup JDK ${{ matrix.java }}
uses: actions/setup-java@v4
with:
distribution: zulu
java-version: ${{ matrix.java }}
- name: Make Gradle wrapper executable
if: ${{ runner.os != 'Windows' }}
run: chmod +x ./gradlew
- name: Build
run: ./gradlew build neoforge:githubRelease neoforge:modrinth neoforge:curseforge fabric:githubRelease fabric:modrinth fabric:curseforge --stacktrace
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
MODRINTH_TOKEN: ${{ secrets.MODRINTH_TOKEN }}
CURSEFORGE_TOKEN: ${{ secrets.CURSEFORGE_TOKEN }}
- name: Capture build artifacts
if: ${{ runner.os == 'Linux' && matrix.java == '21' }}
uses: actions/upload-artifact@v4
with:
name: Artifacts
path: build/libs/
28 changes: 28 additions & 0 deletions .github/workflows/sync-labels.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Synchronizes the repo's labels with labels.yml
# Requires GITHUB_TOKEN to have write permissions; if not, replace it with a custom token
name: Sync Labels

on:
push:
paths: ['.github/labels.yml', '.github/workflows/sync-labels.yml']
workflow_dispatch:

permissions:
issues: write
pull-requests: write

jobs:
sync:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
sparse-checkout: |
.github/labels.yml
sparse-checkout-cone-mode: false
- name: Setup NodeJS
uses: actions/setup-node@v4
with:
node-version: 22
- run: npx github-label-sync -a '${{ secrets.GITHUB_TOKEN }}' -l '.github/labels.yml' ${{ github.repository }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
/.idea/

0 comments on commit 4839ca7

Please sign in to comment.