Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
NotRyken authored Jun 20, 2024
0 parents commit 55da571
Show file tree
Hide file tree
Showing 50 changed files with 2,728 additions and 0 deletions.
479 changes: 479 additions & 0 deletions .editorconfig

Large diffs are not rendered by default.

15 changes: 15 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
* text eol=lf
*.bat text eol=crlf
*.patch text eol=lf
*.java text eol=lf
*.gradle text eol=crlf
*.png binary
*.gif binary
*.exe binary
*.dll binary
*.jar binary
*.lzma binary
*.zip binary
*.pyd binary
*.cfg text eol=lf
*.jks binary
98 changes: 98 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
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://terminalmc.dev/discord).
<br><br>
Additionally, please make check the following:
- **Have you used the [search tool](https://github.com/TerminalMC/Framework/issues) to
check whether your 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 your
problem only occurs with other mods installed, then you should narrow down exactly which
mods are causing the issue. 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. The description should explain what
behavior you were expecting, and why you believe the issue to be a bug. If the issue you
are reporting only occurs with specific mods installed, then provide the name and version
of each mod.
**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: textarea
id: description-reproduction-steps
attributes:
label: Reproduction Steps
description: >-
Describe the procedure required to reproduce this bug. Make sure your instructions are as
clear and concise as possible, because other people will need to be able 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 (optional)
description: >-
**Hint:** You can usually find the log files within the folder `.minecraft/logs`. Generally
you will want the `latest.log` file, since that file belongs to the last played session of
the game.
placeholder: >-
Drag-and-drop the log file here.
- type: textarea
id: crash-report-file
attributes:
label: Crash Report (optional)
description: >-
**Hint:** You can usually find crash reports (with their date and time) in the folder
`.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://terminalmc.dev/discord
about: For any issue that isn't specifically a bug report or feature request, please use Discord
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
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.
- type: markdown
attributes:
value: >-
Make sure you have used the [search tool](https://github.com/TerminalMC/Framework/issues)
to see if a similar request already exists (either open or closed).
- type: textarea
id: description
attributes:
label: Request Description
description: >-
Use this section to 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
tried, 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/
43 changes: 43 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# 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 fabric:githubRelease fabric:modrinth --stacktrace
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
MODRINTH_TOKEN: ${{ secrets.MODRINTH_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 }}
Loading

0 comments on commit 55da571

Please sign in to comment.