Migrate to Apollo

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Setup (please complete the following information):**
+ - OS: [e.g. Windows]
+ - Version [e.g. v1.0.0]
+ - Software [e.g. Bukkit]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/gradle.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will build a Java project with Gradle and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-gradle
+
+name: Java CI with Gradle
+
+on:
+  push
+
+jobs:
+  build:
+    if: "!contains(github.event.head_commit.message, '--skip')"
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+    - uses: actions/checkout@v5
+    - name: Set up JDK 21
+      uses: actions/setup-java@v5
+      with:
+        java-version: '21'
+        distribution: 'temurin'
+
+    - name: Grant execute permission to gradlew
+      run: chmod +x gradlew
+    # Configure Gradle for optimal use in GitHub Actions, including caching of downloaded dependencies.
+    # See: https://github.com/gradle/actions/blob/main/setup-gradle/README.md
+    - name: Setup Gradle
+      uses: gradle/actions/setup-gradle@af1da67850ed9a4cedd57bfd976089dd991e2582 # v4.0.0
+
+    - name: Build with Gradle Wrapper
+      run: ./gradlew shadowJar

.github/workflows/release.yml

@@ -0,0 +1,54 @@
+name: Build & Release
+
+on:
+  push
+
+permissions:
+  contents: write
+
+jobs:
+  build-and-release:
+    if: "contains(github.event.head_commit.message, '--release')"
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+
+      - name: Set up Java
+        uses: actions/setup-java@v5
+        with:
+          distribution: 'temurin'
+          java-version: '21'
+
+      - name: Grant execute permission to gradlew
+        run: chmod +x gradlew
+
+      - name: Build JAR
+        run: ./gradlew shadowJar
+
+
+      - name: Read version from build.gradle
+        id: get_version
+        run: |
+          VERSION=$(grep "^version *= *'" build.gradle | cut -d"'" -f2)
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+          echo "Using version $VERSION for tag"
+
+      - name: Create tag
+        run: |
+          git config user.name "github-actions"
+          git config user.email "github-actions@github.com"
+          git tag ${{ env.VERSION }}
+          git push origin ${{ env.VERSION }}
+
+      - name: Create GitHub Release
+        uses: softprops/action-gh-release@v2
+        with:
+          name: Armstrong-${{ env.VERSION }}
+          tag_name: ${{ env.VERSION }}
+          files: ./build/libs/*.jar
+          body_path: ./CHANGELOG.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -0,0 +1,26 @@
+.gradle/
+build/
+out/
+classes/
+target/
+
+*.launch
+
+.idea/
+*.iml
+*.ipr
+*.iws
+
+.settings/
+.vscode/
+bin/
+.classpath
+.project
+
+*.DS_Store
+
+run/
+
+hs_err_*.log
+*.hprof
+*.jfr

README.md

@@ -1,56 +1,73 @@
-<div align="center">
+<p>
+  <img src="https://cdn.genesis.li/assets/images/armstrong/armstrong-round.png"
+       alt="Armstrong logo" width="170" align="left" />
+</p>
 
-  <img src="https://offlinelc.github.io/assets/img/1621344596076.png" width="200"></img>
-  ## LunarUtility
+### 🚀 Armstrong
+[![Discord](https://img.shields.io/discord/1332991105695875123?logo=discord&label=discord)](https://discord.genesis.li)
+[![Latest Release](https://img.shields.io/github/v/release/Vaption/Armstrong.svg)](https://github.com/Vaption/Armstrong/releases)
+[![License](https://img.shields.io/github/license/Vaption/Armstrong.svg)](https://github.com/Vaption/Armstrong/blob/master/LICENSE)
 
-</small></i>
+**Armstrong** is a simple plugin that utilizes
+[LunarClient](https://lunarclient.com)'s [Apollo API](https://github.com/LunarClient/Apollo).   
+**Found a bug or have a feature idea?** Use the [issues](https://github.com/Vaption/Armstrong/issues) tab!
 
-**LunarUtility** is an a simple plugin that utilizes [LunarClient's](https://github.com/LunarClient) [BukkitAPI](https://github.com/LunarClient/BukkitAPI).
+<br>
 
-If you find any issues, please report them in our <a href="https://github.com/RefineDevelopment/LunarUtility/issues">issues tab</a> and don't forget to star the repository!
-</div>
+## ⚖️ Armstrong vs. LunarUtility
+Originally the goal was just to migrate the codebase to use Apollo rather than the old BukkitAPI.  
+During the migration, I noticed that Apollo (on its own) now does some of what this plugin once did.  
+Therefore, the waypoints & disabled-mods module have been removed from this plugin (now configurable in Apollo).  
+The cooldown module implementation was also removed, but will come back to it after some higher priority updates!
 
-# Notice (UPDATE REGARDING THE LUNARCLIENT API)
-LunarClient have officially released their new API [Apollo](https://github.com/LunarClient/Apollo).\
-They have removed BukkitAPI from their github which is what LunarUtility depends on.\
-We will be updating this soon to utilize Apollo.
+## 🙌 Credits
+Armstrong is based off of [LunarUtility](https://github.com/RefineDevelopment/LunarUtility). All credit to the original developers!
 
-## The Team
-+ [Dubai](https://github.com/GamerRealm) | Original Author
-+ [Komek](https://github.com/Komeek) | Maintainer
-+ [kayalust](https://github.com/kayalust) | Contributor
+👨‍💻 **Contributors**  
+- 🏙️ [Dubai](https://github.com/GamerRealm) – Original Author  
+- 🛠️ [Komek](https://github.com/Komeek) – Maintainer  
+- 💡 [kayalust](https://github.com/kayalust) – Contributor  
 
-## Contact
-- [Discord](https://dsc.gg/refine)
-- [Mail](mailto:refinedevelopment@gmail.com)
-- [Twitter](https://twitter.com/RefineDev)
+## 💬 Contact
+- [Discord](https://discord.genesis.li)
 
-## Installing
-1. Download the jar from <a href="https://github.com/RefineDevelopment/LunarUtility/releases">releases</a>
-2. Download LunarClient's BukkitAPI jar from <a href="https://github.com/LunarClient/BukkitAPI" target="_blank">here</a>
-3. Put both jars in all of your servers
-4. Edit the configuration file to your liking.
+## 📥 Installing
+1️⃣ Download the jar from [releases](https://github.com/Vaption/Armstrong/releases)  
+2️⃣ Download LunarClient's Apollo API jar from [here](https://github.com/LunarClient/Apollo/releases)  
+3️⃣ Drop **both** jars into all your servers  
+4️⃣ Edit the configuration files to your liking  
 
-## Terms of Use
-+ You are not allowed to sell, claim this as your own. Resepect the developer for his contributions and credit them.
+## 📜 Terms of Use
+- No selling or claiming this project as your own  
+- Please respect & credit the developers  
 
-## Pictures
-### Nametag
-![2022-02-10_11 38 33](https://user-images.githubusercontent.com/42650369/154859444-55ffb81b-06b9-497a-9ec5-6c16906b2b83.png)
+## ✨ Features
+<details>
+  <summary>🏷️ <b>Nametag</b></summary>
+  Enabled by default, configurable in <code>config.yml</code>.  
+  <img src="https://user-images.githubusercontent.com/42650369/154859444-55ffb81b-06b9-497a-9ec5-6c16906b2b83.png" />
+</details>
 
-### Kick
-![image](https://github.com/RefineDevelopment/LunarUtility/assets/109939794/d3491af0-22bb-4b71-9355-5a9c194dc6ad)
+<details>
+  <summary>🔒 <b>Require LunarClient</b></summary>
+  Disabled by default. Enable by setting <code>REQUIRE-LUNAR</code> to <code>true</code> in <code>config.yml</code>.  
+  <img src="https://github.com/RefineDevelopment/LunarUtility/assets/109939794/d3491af0-22bb-4b71-9355-5a9c194dc6ad" />
+</details>
 
-### Staff Mods
-![2021-10-26_11 26 09](https://user-images.githubusercontent.com/42650369/138829302-7aeaad61-6cf4-426f-954a-43ace12a972f.png)
-![2021-10-26_11 26 23](https://user-images.githubusercontent.com/42650369/138829317-7a8c6015-e692-4a84-b1d4-395a286454bb.png)
+<details>
+  <summary>🛡️ <b>Staff Mods</b></summary>
+  Requires <code>armstrong.staff</code> permission. Toggle with <code>/lsm &lt;player&gt;</code>.  
+  <img src="https://user-images.githubusercontent.com/42650369/138829302-7aeaad61-6cf4-426f-954a-43ace12a972f.png" />
+</details>
 
-### Commands
-![2021-10-26_11 25 54](https://user-images.githubusercontent.com/42650369/138830339-36b85f2c-5044-4953-b6da-4e67ee30fe84.png)
-![2021-10-26_11 27 38](https://user-images.githubusercontent.com/42650369/138829630-3c2fe296-c3b9-4aae-97f6-0f4b70db5f79.png)
+<details>
+  <summary>🌙 <b>Player on Lunar</b></summary>
+  Requires <code>armstrong.players</code> permission. Check if someone is using LunarClient with <code>/lc &lt;player&gt;</code>.  
+  <img src="https://user-images.githubusercontent.com/42650369/138829302-7aeaad61-6cf4-426f-954a-43ace12a972f.png" />
+</details>
 
-### Waypoints
-![2021-10-26_11 24 51](https://user-images.githubusercontent.com/42650369/138829478-606493b4-072c-429b-897a-c54948407b4b.png)
-
-### Cooldowns
-![2021-10-26_11 26 59](https://user-images.githubusercontent.com/42650369/138830407-ce602bdd-9281-4744-9d3d-105af5223f3f.png)
+<details>
+  <summary>📋 <b>All Players on Lunar</b></summary>
+  Requires <code>armstrong.players</code> permission. Get a list of players on LunarClient with <code>/lc players</code> (or <code>list</code> / <code>users</code>).  
+  <img src="https://user-images.githubusercontent.com/42650369/138829302-7aeaad61-6cf4-426f-954a-43ace12a972f.png" />
+</details>

build.gradle

@@ -0,0 +1,51 @@
+plugins {
+    id 'java'
+    id 'com.gradleup.shadow' version '9.1.0'
+}
+
+group = 'li.genesis.armstrong'
+version = '1.0'
+
+java {
+    toolchain {
+        languageVersion = JavaLanguageVersion.of(8)
+    }
+}
+
+repositories {
+    maven { url 'https://hub.spigotmc.org/nexus/content/repositories/snapshots/' }
+    maven { url "https://repo.aikar.co/content/groups/aikar/" }
+    maven { url 'https://repo.extendedclip.com/releases/' }
+    maven { url 'https://jitpack.io' }
+    maven { url 'https://repo.lunarclient.dev' }
+    mavenCentral()
+}
+
+dependencies {
+    annotationProcessor 'org.projectlombok:lombok:1.18.24'
+    compileOnly 'org.spigotmc:spigot-api:1.8.8-R0.1-SNAPSHOT'
+    compileOnly 'org.projectlombok:lombok:1.18.24'
+    compileOnly 'com.lunarclient:apollo-api:1.2.0'
+    compileOnly 'com.lunarclient:apollo-extra-adventure4:1.2.0'
+    compileOnly 'me.clip:placeholderapi:2.11.6'
+    implementation 'co.aikar:acf-paper:0.5.1-SNAPSHOT'
+    implementation 'org.bstats:bstats-bukkit:3.1.0'
+}
+
+tasks.withType(JavaCompile) {
+    options.encoding = 'UTF-8'
+}
+
+processResources {
+    filteringCharset = 'UTF-8'
+    filesMatching('plugin.yml') {
+        expand(version: project.version)
+    }
+}
+
+shadowJar {
+    archiveClassifier.set('')
+    relocate 'co.aikar.commands', 'li.genesis.aikar.commands'
+    relocate 'co.aikar.locales', 'li.genesis.aikar.locales'
+    relocate 'org.bstats', 'li.genesis.bstats'
+}

gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,7 @@
+distributionBase=GRADLE_USER_HOME
+distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-9.1.0-bin.zip
+networkTimeout=10000
+validateDistributionUrl=true
+zipStoreBase=GRADLE_USER_HOME
+zipStorePath=wrapper/dists