eggy03 · eggy03 · Jun 2, 2026 · May 29, 2026 · May 29, 2026 · May 29, 2026
diff --git a/.github/workflows/publish-container-image.yml b/.github/workflows/publish-container-image.yml
@@ -19,10 +19,10 @@ jobs:
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
       - name: Log in to GHCR
-        uses: docker/login-action@v3
+        uses: docker/login-action@v4
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,5 +1,7 @@
-This project does not accept pull requests.
+This project does not accept pull requests. I haven't been getting enough time to set up a contribution guideline.
+I will start accepting PRs once a guideline is in effect.
 
-If you would like to modify or extend the bot, please feel free to fork the repository and maintain your own version.
+Meanwhile, please feel free to fork the repository and maintain your own version. In case of any doubt or question
+regarding the codebase, you can open an issue in GitHub.
 
-Bug reports and suggestions are welcome through the Issues tab. I may review and address them as time permits.
+Bug reports and suggestions are also welcome through the Issues tab. I may review and address them as time permits.
diff --git a/Dockerfile b/Dockerfile
@@ -23,6 +23,6 @@ WORKDIR /app
 VOLUME /tmp
 
 # Copy the JAR from the build stage
-COPY --from=build --chown=papertrail:papertrail /app/target/papertrailbot-jar-with-dependencies.jar papertrailbot.jar
+COPY --from=build --chown=papertrail:papertrail /app/target/quarkus-app bot
 USER papertrail
-ENTRYPOINT ["java","-jar","papertrailbot.jar"]
+ENTRYPOINT ["java","-jar","bot/quarkus-run.jar"]
diff --git a/README.md b/README.md
@@ -13,7 +13,9 @@
 * [Self-Host (Manual Configuration)](#self-host-manual-configuration)
 * [Sharding (Advanced Configuration)](#sharding-advanced-configuration)
 * [Synchronizing Rate Limits (Advanced Configuration)](#synchronizing-rate-limits-advanced-configuration)
+* [Health Checks and Custom Port Configuration](#health-checks-and-custom-port-configuration)
 * [License](#license)
+* [AI Usage Declaration and Policy](#ai-usage-declaration-and-policy)
 * [Help](#help)
 
 # Overview
@@ -97,10 +99,10 @@ Don't forget to copy the `bot token` as it will be required in the next step
 
 ### Step 2.2: Get Required Secrets
 
-| Variable  | Description                                                        |
-|-----------|--------------------------------------------------------------------|
-| `TOKEN`   | Discord application bot token (from the Developer Portal)          |
-| `API_URL` | Internal URL of the PaperTrail API (e.g., `http://localhost:8080`) |
+| Variable  | Description                                                        | Default Value    | Optional |
+|-----------|--------------------------------------------------------------------|------------------|----------|
+| `TOKEN`   | Discord application bot token (from the Developer Portal)          | No Default Value | No       |
+| `API_URL` | Internal URL of the PaperTrail API (e.g., `http://localhost:8080`) | No Default Value | No       |
 
 Example `.env` file:
 
@@ -172,11 +174,11 @@ Discord allows you to have up to 2500 guilds per shard but the recommended confi
 
 You will need the following additional environment variables for custom shard configuration.
 
-| Variable       | Description                                                                   |
-|----------------|-------------------------------------------------------------------------------|
-| `TOTAL_SHARDS` | Total number of shards used by the bot across all running processes/instances |
-| `MIN_SHARD_ID` | The first shard ID handled by this specific bot instance                      |
-| `MAX_SHARD_ID` | The last shard ID handled by this specific bot instance                       |
+| Variable       | Description                                                                   | Default Value | Optional |
+|----------------|-------------------------------------------------------------------------------|---------------|----------|
+| `TOTAL_SHARDS` | Total number of shards used by the bot across all running processes/instances | 1             | Yes      |
+| `MIN_SHARD_ID` | The first shard ID handled by this specific bot instance                      | 0             | Yes      |
+| `MAX_SHARD_ID` | The last shard ID handled by this specific bot instance                       | 0             | Yes      |
 
 Shard IDs start at 0.
 
@@ -277,9 +279,9 @@ This will set the discord token to `"my token"` and map the bound port to port `
 
 Add the following environment variable to your bot:
 
-| Variable    | Description                                                                                                                |
-|-------------|----------------------------------------------------------------------------------------------------------------------------|
-| `PROXY_URL` | Base URL for the HTTP proxy that will receive Discord API requests instead of discord.com (Example: http://localhost:3000) |
+| Variable                  | Description                                                                                                                | Default Value | Optional |
+|---------------------------|----------------------------------------------------------------------------------------------------------------------------|---------------|----------|
+| `TWILIGHT_HTTP_PROXY_URL` | Base URL for the HTTP proxy that will receive Discord API requests instead of discord.com (Example: http://localhost:3000) | Blank         | Yes      |
 
 When configured, all Discord API requests made by the bot will be routed through the proxy.
 
@@ -300,12 +302,58 @@ as the instance-level. While this should not create functional conflicts,
 it may lead to under-utilization of the rate limits provided by Discord and can reduce the overall throughput of your
 bot cluster.
 
+# Health Checks and Custom Port Configuration
+
+## Health Checks
+
+Since v4, it is possible to get health information by probing any of the following health endpoints:
+
+| Endpoint            | Description                                                                                           |
+|---------------------|-------------------------------------------------------------------------------------------------------|
+| `/q/health`         | Aggregated health status containing all registered checks.                                            |
+| `/q/health/live`    | Liveness probe. Verifies that the bot process is healthy and that all shards are operating normally.  |
+| `/q/health/ready`   | Readiness probe. Verifies that all shards are fully connected to Discord and ready to receive events. |
+| `/q/health/started` | Startup probe. Indicates whether the application has completed its startup sequence.                  |
+
+### Liveness Check
+
+The liveness check reports **UP** when all shards belonging to this instance are in one of the following states:
+
+* `CONNECTED`
+* `ATTEMPTING_TO_RECONNECT`
+* `RECONNECT_QUEUED`
+* `WAITING_TO_RECONNECT`
+
+### Readiness Check
+
+The readiness check reports **UP** only when every shard belonging to this instance is fully `CONNECTED` to Discord.
+
+## Custom Port Configuration
+
+By, default PaperTrail runs on port 8080. If port 8080 is occupied by a different service, or you wish to
+run the application on a different port, you can manually set the `PORT` environment variable.
+
+| Variable | Description                                           | Default Value | Optional |
+|----------|-------------------------------------------------------|---------------|----------|
+| `PORT`   | Port Number on which the instance of the bot will run | 8080          | Yes      |
+
 # License
 
 This project is licensed under the [AGPLv3](/LICENSE) license.
-Read this
-easy-to-understand [Medium](https://medium.com/swlh/understanding-the-agpl-the-most-misunderstood-license-86fd1fe91275)
-article about AGPLv3 and it's scope.
+
+# AI Usage Declaration and Policy
+
+No AI or LLM agents have been used to generate any part of the project's source code.
+This policy applies to all existing source code and future code contributions.
+
+After two years of development and manual testing, the application has reached a fairly stable and maintainable state.
+To preserve code quality, maintainability, format, and stability,
+AI-generated source code is **not accepted** for inclusion in this repository and the repositories related to the
+application.
+
+Limited use of AI for non-code tasks, such as commit message generation, spelling correction,
+or documentation proofreading, may be permitted at the maintainer's discretion.
+Such usage does not constitute authorship of the project's source code.
 
 # Help
 

diff --git a/pom.xml b/pom.xml
@@ -1,66 +1,87 @@
-<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xmlns="http://maven.apache.org/POM/4.0.0"
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
-
     <modelVersion>4.0.0</modelVersion>
-
     <groupId>io.github.eggy03</groupId>
     <artifactId>papertrailbot</artifactId>
-    <version>3.7.3</version>
+    <version>4.0.0</version>
     <name>PaperTrail Bot</name>
     <description>A simple bot for logging all server and member actions</description>
+    <packaging>quarkus</packaging>
 
     <properties>
+        <!-- Project Properties -->
+        <maven.compiler.release>25</maven.compiler.release>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-        <maven.compiler.release>25</maven.compiler.release>
+
+        <!-- Quarkus Properties -->
+        <quarkus.platform.artifact-id>quarkus-bom</quarkus.platform.artifact-id>
+        <quarkus.platform.group-id>io.quarkus.platform</quarkus.platform.group-id>
+        <quarkus.platform.version>3.35.4</quarkus.platform.version>
+        <skipITs>true</skipITs>
 
         <!-- Dependency Versions -->
         <jda.version>6.4.1</jda.version>
-        <papertrail.sdk.version>2.0.4</papertrail.sdk.version>
-        <tinylog.version>2.7.0</tinylog.version>
-        <dotenv.version>3.2.0</dotenv.version>
+        <papertrail.sdk.version>2.0.5</papertrail.sdk.version>
         <commons-lang3.version>3.20.0</commons-lang3.version>
         <guava.version>33.5.0-jre</guava.version>
+        <jetbrains.annotations.version>26.1.0</jetbrains.annotations.version>
         <lombok.version>1.18.46</lombok.version>
 
         <!-- Plugin Versions -->
-        <maven.assembly.plugin.version>3.8.0</maven.assembly.plugin.version>
-        <maven-compiler-plugin.version>3.15.0</maven-compiler-plugin.version>
-
-        <!-- Extras -->
-        <app.main.class>io.github.eggy03.papertrail.bot.main.Start</app.main.class>
+        <compiler-plugin.version>3.15.0</compiler-plugin.version>
+        <surefire-plugin.version>3.5.5</surefire-plugin.version>
     </properties>
 
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>${quarkus.platform.group-id}</groupId>
+                <artifactId>${quarkus.platform.artifact-id}</artifactId>
+                <version>${quarkus.platform.version}</version>
+                <type>pom</type>
+                <scope>import</scope>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
     <dependencies>
+
+        <!-- DI -->
         <dependency>
-            <groupId>net.dv8tion</groupId>
-            <artifactId>JDA</artifactId>
-            <version>${jda.version}</version>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-arc</artifactId>
         </dependency>
 
+        <!-- Health -->
         <dependency>
-            <groupId>org.tinylog</groupId>
-            <artifactId>slf4j-tinylog</artifactId>
-            <version>${tinylog.version}</version>
+            <groupId>io.quarkus</groupId>
+            <artifactId>quarkus-smallrye-health</artifactId>
         </dependency>
+
+        <!-- JDA -->
         <dependency>
-            <groupId>org.tinylog</groupId>
-            <artifactId>tinylog-api</artifactId>
-            <version>${tinylog.version}</version>
+            <groupId>net.dv8tion</groupId>
+            <artifactId>JDA</artifactId>
+            <version>${jda.version}</version>
         </dependency>
+
+        <!-- Annotations -->
         <dependency>
-            <groupId>org.tinylog</groupId>
-            <artifactId>tinylog-impl</artifactId>
-            <version>${tinylog.version}</version>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <version>${lombok.version}</version>
+            <scope>provided</scope>
         </dependency>
 
         <dependency>
-            <groupId>io.github.cdimascio</groupId>
-            <artifactId>dotenv-java</artifactId>
-            <version>${dotenv.version}</version>
+            <groupId>org.jetbrains</groupId>
+            <artifactId>annotations</artifactId>
+            <version>${jetbrains.annotations.version}</version>
         </dependency>
 
+        <!-- Other -->
         <dependency>
             <groupId>org.apache.commons</groupId>
             <artifactId>commons-lang3</artifactId>
@@ -79,49 +100,22 @@
             <version>${papertrail.sdk.version}</version>
         </dependency>
 
-        <dependency>
-            <groupId>org.projectlombok</groupId>
-            <artifactId>lombok</artifactId>
-            <version>${lombok.version}</version>
-            <scope>provided</scope>
-        </dependency>
     </dependencies>
 
     <build>
         <finalName>${project.artifactId}</finalName>
-
         <plugins>
             <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
-                <artifactId>maven-assembly-plugin</artifactId>
-                <version>${maven.assembly.plugin.version}</version>
-                <configuration>
-                    <archive>
-                        <manifest>
-                            <addClasspath>true</addClasspath>
-                            <mainClass>${app.main.class}</mainClass>
-                        </manifest>
-                    </archive>
-                    <descriptorRefs>
-                        <descriptorRef>jar-with-dependencies</descriptorRef>
-                    </descriptorRefs>
-                </configuration>
-                <executions>
-                    <execution>
-                        <id>assemble-all</id>
-                        <phase>package</phase>
-                        <goals>
-                            <goal>single</goal>
-                        </goals>
-                    </execution>
-                </executions>
+                <groupId>${quarkus.platform.group-id}</groupId>
+                <artifactId>quarkus-maven-plugin</artifactId>
+                <version>${quarkus.platform.version}</version>
+                <extensions>true</extensions>
             </plugin>
-
             <plugin>
-                <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
-                <version>${maven-compiler-plugin.version}</version>
+                <version>${compiler-plugin.version}</version>
                 <configuration>
+                    <parameters>true</parameters>
                     <annotationProcessorPaths>
                         <path>
                             <groupId>org.projectlombok</groupId>
@@ -131,7 +125,54 @@
                     </annotationProcessorPaths>
                 </configuration>
             </plugin>
+            <plugin>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>${surefire-plugin.version}</version>
+                <configuration>
+                    <argLine>@{argLine}</argLine>
+                    <systemPropertyVariables>
+                        <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
+                        <maven.home>${maven.home}</maven.home>
+                    </systemPropertyVariables>
+                </configuration>
+            </plugin>
+            <plugin>
+                <artifactId>maven-failsafe-plugin</artifactId>
+                <version>${surefire-plugin.version}</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>integration-test</goal>
+                            <goal>verify</goal>
+                        </goals>
+                    </execution>
+                </executions>
+                <configuration>
+                    <argLine>@{argLine}</argLine>
+                    <systemPropertyVariables>
+                        <native.image.path>${project.build.directory}/${project.artifactId}-runner</native.image.path>
+                        <java.util.logging.manager>org.jboss.logmanager.LogManager</java.util.logging.manager>
+                        <maven.home>${maven.home}</maven.home>
+                    </systemPropertyVariables>
+                </configuration>
+            </plugin>
         </plugins>
     </build>
 
+    <profiles>
+        <profile>
+            <id>native</id>
+            <activation>
+                <property>
+                    <name>native</name>
+                </property>
+            </activation>
+            <properties>
+                <quarkus.package.jar.enabled>false</quarkus.package.jar.enabled>
+                <skipITs>false</skipITs>
+                <quarkus.native.enabled>true</quarkus.native.enabled>
+            </properties>
+        </profile>
+    </profiles>
 </project>
+