Skip to content

Commit

Permalink
Finished few other repos, will ping a few others to commit their own …
Browse files Browse the repository at this point in the history
…tools with xml format.
  • Loading branch information
Dawsson committed Feb 21, 2024
1 parent 36c084c commit 54d091a
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 8 deletions.
1 change: 1 addition & 0 deletions Writerside/flyte.tree
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@

<toc-element toc-title="GitHub Actions">

<toc-element topic="Resource-Pack-Deploy.md"/>
<toc-element topic="Ptero-Build-Flow.md"/>
</toc-element>

Expand Down
4 changes: 2 additions & 2 deletions Writerside/topics/MongoDB.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand All @@ -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`.
Expand Down
26 changes: 26 additions & 0 deletions Writerside/topics/Resource-Pack-Deploy.md
Original file line number Diff line number Diff line change
@@ -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/<username>/<repository>/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.
9 changes: 4 additions & 5 deletions Writerside/topics/libraries/Neptune.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -95,18 +94,18 @@ Maven
<dependency>
<groupId>gg.flyte</groupId>
<artifactId>neptune</artifactId>
<version>VERSION</version>
<version>%NEPTUNE_VERSION%</version>
</dependency>
```

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
Expand Down
2 changes: 2 additions & 0 deletions Writerside/topics/libraries/Twilight.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 1 addition & 1 deletion Writerside/topics/scripts/Ptero-Build-Flow.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit 54d091a

Please sign in to comment.