diff options
| -rw-r--r-- | .github/CODEOWNERS | 8 | ||||
| -rw-r--r-- | .github/CODE_OF_CONDUCT.md | 3 | ||||
| -rw-r--r-- | .github/SECURITY.md | 16 | ||||
| -rw-r--r-- | .github/SUPPORT.md | 7 | ||||
| -rw-r--r-- | .github/workflows/build.yml | 86 | ||||
| -rw-r--r-- | CONTRIBUTING.md | 4 | ||||
| -rw-r--r-- | README.md | 44 |
7 files changed, 106 insertions, 62 deletions
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 327c4e17..94fc9f8f 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -1,3 +1,11 @@ /src/main/java/io/github/moulberry/notenoughupdates/recipes/* @romangraef /src/main/java/io/github/moulberry/notenoughupdates/miscgui/GuiItemRecipe.java @romangraef /*gradle* @romangraef +/README.md @IRONM00N +/CONTRIBUTING.md @romangraef @IRONM00N +/.editorconfig @IRONM00N +/.github/CODE_OF_CONDUCT.md @IRONM00N +/.github/SECURITY.md @IRONM00N +/.github/SUPPORT.md @IRONM00N +/.idea/codeStyles/* @IRONM00N +/.idea/copyright/* @IRONM00N diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..e91612f1 --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,3 @@ +# Contributor Code of Conduct + +Don't be a jerk. diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 00000000..7510a34d --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,16 @@ +# Security Policy + +## Supported Versions + +The following versions of the mod support security updates. + +| Version | Supported | +| ------- | ------------------ | +| > 2.0 | :x: | +| 2.0.x | :white_check_mark: | +| 2.1.x | :white_check_mark: | + +## Reporting a Vulnerability + +Please report vulnerabilities in our [discord server](https://discord.gg/moulberry) by creating a new +ticket in #bot-commands with the command `/new <reason>`. diff --git a/.github/SUPPORT.md b/.github/SUPPORT.md new file mode 100644 index 00000000..24328844 --- /dev/null +++ b/.github/SUPPORT.md @@ -0,0 +1,7 @@ +<!-- markdownlint-disable MD034 --> + +# Obtain Support for NotEnoughUpdates + +If you are struggling to install the mod, having issues with it, experiencing +unexpected crashes, or have another issue: join our community [discord server](https://discord.gg/moulberry) +and ask for help in the #neu-support channel. diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 0440aefb..4d6c2b23 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -3,20 +3,20 @@ name: Build on: push: branches: - - '*' + - "*" paths-ignore: - - 'README.md' - - 'LICENSE.md' - - 'LICENSE-GPLv3.md' - - '.gitignore' + - "README.md" + - "COPYING" + - "COPYING.LESSER" + - ".gitignore" pull_request: branches: - - '*' + - "*" paths-ignore: - - 'README.md' - - 'LICENSE.md' - - 'LICENSE-GPLv3.md' - - '.gitignore' + - "README.md" + - "COPYING" + - "COPYING.LESSER" + - ".gitignore" workflow_dispatch: jobs: build: @@ -28,36 +28,36 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - name: Send discord notification - id: sendmsg - if: ${{ env.WEBHOOK_URL }} - run: | - ./.github/workflows/send_webhook_update.sh - env: - STATUS: WORKING - - name: Set up JDK 17 - uses: actions/setup-java@v2 - with: - java-version: 17 - distribution: temurin - cache: gradle - - name: Build with Gradle - run: chmod +x ./gradlew && ./gradlew clean test remapJar --no-daemon - - uses: actions/upload-artifact@v2 - with: - path: build/libs/*-dep.jar - - name: Update discord notification - if: ${{ env.WEBHOOK_URL && success() }} - run: | - ./.github/workflows/send_webhook_update.sh - env: - STATUS: SUCCESS - MESSAGE_ID: ${{ steps.sendmsg.outputs.MESSAGE_ID }} - - name: Update discord notification - if: ${{ env.WEBHOOK_URL && failure() }} - run: | - ./.github/workflows/send_webhook_update.sh - env: - STATUS: FAILURE - MESSAGE_ID: ${{ steps.sendmsg.outputs.MESSAGE_ID }} + - uses: actions/checkout@v2 + - name: Send discord notification + id: sendmsg + if: ${{ env.WEBHOOK_URL }} + run: | + ./.github/workflows/send_webhook_update.sh + env: + STATUS: WORKING + - name: Set up JDK 17 + uses: actions/setup-java@v2 + with: + java-version: 17 + distribution: temurin + cache: gradle + - name: Build with Gradle + run: chmod +x ./gradlew && ./gradlew clean test remapJar --no-daemon + - uses: actions/upload-artifact@v2 + with: + path: build/libs/*-dep.jar + - name: Update discord notification + if: ${{ env.WEBHOOK_URL && success() }} + run: | + ./.github/workflows/send_webhook_update.sh + env: + STATUS: SUCCESS + MESSAGE_ID: ${{ steps.sendmsg.outputs.MESSAGE_ID }} + - name: Update discord notification + if: ${{ env.WEBHOOK_URL && failure() }} + run: | + ./.github/workflows/send_webhook_update.sh + env: + STATUS: FAILURE + MESSAGE_ID: ${{ steps.sendmsg.outputs.MESSAGE_ID }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6c163317..922bdf60 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,5 @@ +# Contributing + ## Before you contribute - Please check your feature / bug isn't already fixed in one of our pre-releases or on [the development branch](https://github.com/NotEnoughUpdates/NotEnoughUpdates/tree/master/). @@ -23,7 +25,7 @@ - Optionally, run the `genSources` gradle task. - Run the `Minecraft Client` to make sure that everything works. -## Logging into Hypixel in a development environment. +## Logging into Hypixel in a development environment Use [DevAuth](https://github.com/DJtheRedstoner/DevAuth). Download the `forge-legacy` version, and put it into the `run/mods` folder. Then follow the configuration instructions in the [DevAuth README](https://github.com/DJtheRedstoner/DevAuth#configuration-file) @@ -1,21 +1,17 @@ -<!-- markdownlint-disable-file MD033 --> -<h1 align="center"> NotEnoughUpdates </h1> +<!-- markdownlint-disable-file MD001 MD033 --> +<h1 align="center">NotEnoughUpdates</h1> -<p align="center"> +<div align="center"> <!-- release --> - <a href="https://github.com/Moulberry/NotEnoughUpdates-REPO/releases/latest" target="_blank"> + <a href="https://github.com/Moulberry/NotEnoughUpdates/releases/latest" target="_blank"> <img src="https://img.shields.io/github/v/release/Moulberry/NotEnoughUpdates-REPO?color=informational&include_prereleases&label=release&logo=github&logoColor=white" alt="release"> </a> - <!-- downloads --> - <!-- <a href="https://github.com/Moulberry/NotEnoughUpdates/releases" target="_blank"> - <img src="https://img.shields.io/github/downloads/Moulberry/NotEnoughUpdates/total?logo=GitHub&color=informational" alt="downloads"> - </a> --> <!-- lines --> <a href="https://github.com/NotEnoughUpdates/NotEnoughUpdates/graphs/code-frequency" target="_blank"> <img src="https://img.shields.io/tokei/lines/github/NotEnoughUpdates/NotEnoughUpdates?label=lines&color=informational&logo=GitHub" alt="lines"> </a> <!-- license --> - <a href="https://github.com/NotEnoughUpdates/NotEnoughUpdates/blob/master/COPYING.LESSER" target="_blank"> + <a href="./COPYING.LESSER" target="_blank"> <img src="https://img.shields.io/github/license/NotEnoughUpdates/NotEnoughUpdates?color=informational" alt="license"> </a> <!-- contributors --> @@ -30,15 +26,13 @@ <a href="https://github.com/Moulberry/NotEnoughUpdates/releases" target="_blank"> <img src="https://img.shields.io/github/downloads/Moulberry/NotEnoughUpdates/total?label=downloads&color=informational&logo=GitHub" alt="downloads"> </a> -</p> +</div> NotEnoughUpdates (NEU) is a feature rich 1.8.9 Minecraft forge mod for Hypixel Skyblock. ## Getting Started -<i>If you want to install NEU for development purposes, see [CONTRIBUTING](CONTRIBUTING.md)</i> - -<u>**Installing Forge:**</u> +#### Installing Forge 1. Run normal Minecraft 1.8.9 and once it reaches the title screen wait about 5 seconds and close it. 2. Install Minecraft **1.8.9** forge from the [forge website](http://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.8.9.html) @@ -47,9 +41,9 @@ NotEnoughUpdates (NEU) is a feature rich 1.8.9 Minecraft forge mod for Hypixel S 4. When forge is installed, open the Minecraft launcher, go under the `installations tab`, click `new installation`, select the version release `1.8.9-forge1.8.9-11.15.1.xxxx` (it will usually be all the way towards the bottom). 5. Once you are done, run this new installation that you just created. Once it reaches the title screen, wait about 5 seconds and close it. -<u>**Installing the NotEnoughUpdates mod:**</u> +#### Installing the NotEnoughUpdates mod -1. Download the latest mod [release](https://github.com/Moulberry/NotEnoughUpdates/releases). If it says `this file may harm your computer`, click `allow anyways` as all java files will be flagged by Chrome. +1. Download the latest mod [release](https://github.com/NotEnoughUpdates/NotEnoughUpdates-REPO/releases). If it says `this file may harm your computer`, click `allow anyways` as all java files will be flagged by Chrome. 2. Add the NEU mod: - If you have java installed, double click the file, click `install` - If not, press the windows key + R; type `%appdata%`; click on the folder called `.minecraft`; click on the folder called `mods` and drag the mods file in here. @@ -57,11 +51,9 @@ NotEnoughUpdates (NEU) is a feature rich 1.8.9 Minecraft forge mod for Hypixel S 4. Then, hop onto Skyblock and run the command `/api new`. Your api key is automatically filled out and all features should work. 5. Type `/neu`. If you see the NotEnoughUpdates menu, you have done this correctly! -_If you need further assistance feel free to join the [discord](https://discord.gg/moulberry) and ask for help in [#neu-support](discord://discord.com/channels/516977525906341928/714332750156660756)_ - ## Features -- An [item list](https://github.com/Moulberry/NotEnoughUpdates-REPO) containing information and recipes about every item in skyblock. +- An [item list](https://github.com/NotEnoughUpdates/NotEnoughUpdates-REPO) containing information and recipes about every item in skyblock. - A dungeons minimap. - Dungeon loot profit checker. - Item overlays for Treecapitator, Builder's Wand, Block Zapper, and Bonemerang. @@ -79,3 +71,19 @@ _If you need further assistance feel free to join the [discord](https://discord. - Slot Locking - Fishing Particle customization & alerts. - And [much, much, more.](https://gist.github.com/jani270/d33e249d40b0333b87ba5c5e70fca398) + +## Support + +If you need assistance installing or using the mod, feel free to join the [discord](https://discord.gg/moulberry) and ask for help in [#neu-support](discord://discord.com/channels/516977525906341928/714332750156660756) + +## Contributing + +If you would like to contribute to the project, look at our [contribution guide](CONTRIBUTING.md) for more information how to install NEU for development purposes. + +## Security + +If you have found a vulnerability, please follow our [security policy](.github/SECURITY.md). + +## License + +This project is licensed under LGPL-3.0-or-later, see [COPYING](COPYING) and [COPYING.LESSER](COPYING.LESSER) for more details. |