From 54d091a6e93e17740b017d5e07c9b6a8e6b661a6 Mon Sep 17 00:00:00 2001 From: Dawson Date: Tue, 20 Feb 2024 23:17:21 -0500 Subject: [PATCH] Finished few other repos, will ping a few others to commit their own tools with xml format. --- Writerside/flyte.tree | 1 + Writerside/topics/MongoDB.md | 4 +-- Writerside/topics/Resource-Pack-Deploy.md | 26 +++++++++++++++++++ Writerside/topics/libraries/Neptune.md | 9 +++---- Writerside/topics/libraries/Twilight.md | 2 ++ Writerside/topics/scripts/Ptero-Build-Flow.md | 2 +- 6 files changed, 36 insertions(+), 8 deletions(-) create mode 100644 Writerside/topics/Resource-Pack-Deploy.md diff --git a/Writerside/flyte.tree b/Writerside/flyte.tree index b488b40..1a8ca60 100644 --- a/Writerside/flyte.tree +++ b/Writerside/flyte.tree @@ -34,6 +34,7 @@ + diff --git a/Writerside/topics/MongoDB.md b/Writerside/topics/MongoDB.md index 65bc2f1..0ee1595 100644 --- a/Writerside/topics/MongoDB.md +++ b/Writerside/topics/MongoDB.md @@ -12,7 +12,7 @@ MONGO_DATABASE="your database name" #### Builder When building your Twilight instance, you can specify your URI and database like so: -```kotlin +```Kotlin val twilight = twilight(plugin) { mongo { uri = "your URI string" @@ -22,7 +22,7 @@ val twilight = twilight(plugin) { ``` From here you can use the following function to get a collection from your database: -```kotlin +```Kotlin MongoDB.collection("my-collection") ``` And use the standard features of the Mongo Sync Driver with your `MongoCollection`. diff --git a/Writerside/topics/Resource-Pack-Deploy.md b/Writerside/topics/Resource-Pack-Deploy.md new file mode 100644 index 0000000..9553ee9 --- /dev/null +++ b/Writerside/topics/Resource-Pack-Deploy.md @@ -0,0 +1,26 @@ +# Resource Pack Deploy + +[GitHub Repository](https://github.com/flytegg/resource-pack-deploy) + +This is a GitHub Action designed for Minecraft resource packs which will zip up your repository and automatically create a release on commit. This means you can use one universal link in the Spigot setResourcePack function, and merely have to commit to the repository for players to start using your new pack. + +Whilst the ideal would be to simply serve the latest version of the repository through using the "Download ZIP" feature, for some reason GitHub decides to put your repository files inside a folder inside of a .zip, which is not a valid resource pack. The flow ensures that so long as your files are at the root of your repository then it will serve a valid resource pack. + +Action steps: +- **Trigger on Push to Master Branch:** Initiates the workflow whenever changes are pushed to the master branch. +- **Checkout Code:** Pulls the latest code from the master branch into the workflow environment. +- **Create ZIP File:** Packages the codebase into a ZIP file, including the short commit ID in the file's name for version tracking. +- **Upload ZIP Artifact:** Uploads the created ZIP file as an artifact to the workflow run for later access or download. +- **Create Release:** Automatically generates a new GitHub release, tagged with the current commit SHA, making the ZIP file available in the repository's releases. +- **Upload Release Artifact:** Attaches the ZIP file to the corresponding GitHub release, making it accessible for users to download the latest version. + +Setup steps: +1. Create a Personal Access Token (PAT) which has permissions for your repository +2. Add your PAT as a secret variable in the repository with the name "RESOURCE_ZIPPER" + +After the first run, your resource pack can then be accessed at this link: +`https://github.com///releases/latest/download/RP.zip` + +This will automatically download the latest release which you can serve to players using the setResourcePack function. + +For an example of a repository successfully using this flow, see https://github.com/flytegg/ls-christmas-rp. diff --git a/Writerside/topics/libraries/Neptune.md b/Writerside/topics/libraries/Neptune.md index bee1d66..a5f0a3a 100644 --- a/Writerside/topics/libraries/Neptune.md +++ b/Writerside/topics/libraries/Neptune.md @@ -1,8 +1,7 @@ # Neptune -[Github Repository](https://github.com/flytegg/neptune) +[GitHub Repository](https://github.com/flytegg/neptune) -## Information An annotation-based slash command framework for JDA. ## How to Use @@ -95,18 +94,18 @@ Maven gg.flyte neptune - VERSION + %NEPTUNE_VERSION% ``` Gradle (Kotlin DSL) -```Kotlin +```kt maven { name = "flyteRepositoryReleases" url = uri("https://repo.flyte.gg/releases") } -implementation("gg.flyte:neptune:VERSION") +implementation("gg.flyte:neptune:%NEPTUNE_VERSION%") ``` ## Contributing diff --git a/Writerside/topics/libraries/Twilight.md b/Writerside/topics/libraries/Twilight.md index 7dd36d2..75b8016 100644 --- a/Writerside/topics/libraries/Twilight.md +++ b/Writerside/topics/libraries/Twilight.md @@ -1,6 +1,8 @@ # Twilight ✨ +[GitHub Repository](https://github.com/flytegg/twilight) + Twilight is an API for developers creating plugins for Spigot or Paper based Minecraft servers. It contains a wide range of utilities and QOL improvements, from inventories, to schedulers and databases. Twilight is built using **Kotlin**, and is recommended for usage with. diff --git a/Writerside/topics/scripts/Ptero-Build-Flow.md b/Writerside/topics/scripts/Ptero-Build-Flow.md index 9256abd..f212585 100644 --- a/Writerside/topics/scripts/Ptero-Build-Flow.md +++ b/Writerside/topics/scripts/Ptero-Build-Flow.md @@ -1,6 +1,6 @@ # Ptero Build Flow -[Github Repository](https://github.com/flytegg/ptero-build-flow) +[GitHub Repository](https://github.com/flytegg/ptero-build-flow) ## Information