Better Fabric Console v2

.github/workflows/build.yml

@@ -16,4 +16,5 @@ jobs:
       modrinth-publish: true
       artifacts-path: 'build/libs/better-fabric-console-mc*.jar'
       loom: true
-      jdk-version: 21
+      jdk-version: 25
+      init-submodules: true

.gitignore

@@ -8,6 +8,7 @@ classes/
 # eclipse
 
 *.launch
+.factorypath
 
 # idea
 

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "endermux"]
+	path = endermux
+	url = https://github.com/jpenilla/endermux.git

AGENTS.md

@@ -0,0 +1,17 @@
+## Fast Start
+
+- See `README.md` for background info.
+- To test compilation, run: `./gradlew compileJava`.
+- To run checks, use: `./gradlew check`.
+- Verify your work at the end even if not explicitly requested.
+
+## Endermux
+
+- Endermux modules live in the `endermux/` git submodule and are wired into this repo via `includeBuild("./endermux")` in `settings.gradle.kts`.
+- For any work in Endermux code/docs, read and follow `endermux/AGENTS.md` first.
+- When validating Endermux changes from the repo root, either `cd endermux` and run its tasks directly, or use composite-prefixed tasks like `./gradlew :endermux:endermux-common:compileJava :endermux:endermux-server:compileJava :endermux:endermux-client:compileJava`.
+
+## Documentation
+
+- Keep `AGENTS.md` in sync with repository structure and build setup.
+- If behavior and docs diverge, fix both in the same change.

README.md

@@ -1,5 +1,87 @@
 # Better Fabric Console
 
-Server-side Fabric mod enhancing the console with tab completions, colored log output, command syntax highlighting, command history, and more.
+<img src="src/main/resources/assets/better-fabric-console/icon.png" alt="Better Fabric Console icon" width="128" />
 
-Better Fabric Console is configurable through the `better-fabric-console.conf` file generated in the config folder. Requires [Fabric-API](https://modrinth.com/mod/fabric-api).
+Better Fabric Console is a server-side Fabric mod that replaces the vanilla dedicated server console experience with an interactive, color-aware terminal.
+
+## Features
+
+- Brigadier-aware command completion in the server console
+- Command syntax highlighting with configurable argument colors
+- Colored log output in terminal consoles
+- Persistent command history in `.console_history`
+- Optional logging of player-executed commands
+- Optional [Endermux](https://github.com/jpenilla/endermux) remote console server
+
+![Screenshot 1](docs/images/screenshot_1.png)
+
+## Requirements
+
+- Fabric server
+- [Fabric API](https://modrinth.com/mod/fabric-api)
+- [adventure-platform-fabric](https://modrinth.com/mod/adventure-platform-mod)
+
+## Installation
+
+1. Download the latest Better Fabric Console, Fabric API, and adventure-platform-fabric jars.
+2. Place the jars in your server `mods/` directory.
+3. Start the server once to generate config files.
+4. Stop the server and edit configuration as needed.
+5. Start the server again.
+
+You may also choose to run the server with the `--nogui` argument (i.e. `java -jar fabric.jar --nogui`)
+to disable the server GUI (this is a Vanilla option).
+
+## Configuration
+
+Better Fabric Console generates and reads:
+
+- `config/better-fabric-console/better-fabric-console.conf`
+- `config/better-fabric-console/log4j2.xml`
+
+Default `better-fabric-console.conf` for reference:
+
+```hocon
+# Specify argument highlight colors, in order. Possible values: [BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE]
+highlight-colors=[
+    CYAN,
+    YELLOW,
+    GREEN,
+    MAGENTA,
+    BLUE
+]
+# Whether to log commands executed by players to console.
+log-player-executed-commands=true
+# Endermux remote console server configuration.
+endermux {
+    # Whether to enable the Endermux remote console server.
+    enabled=false
+    # Path to the socket file relative to the server directory.
+    socket-path="console.sock"
+    # Maximum number of concurrent socket connections.
+    max-connections=5
+}
+```
+
+[Click here](src/main/resources/better-fabric-console-default-log4j2.xml) to see the default `log4j2.xml` configuration.
+
+Better Fabric Console also respects the following system properties to override terminal environment detection:
+- Adventure ANSI properties: https://docs.papermc.io/adventure/serializer/ansi/
+
+Changes require a server restart.
+
+## Endermux Remote Console Server
+
+Better Fabric Console also includes the [Endermux](https://github.com/jpenilla/endermux) remote console server (disabled by default, see configuration above).
+
+This allows for attaching to a fully-featured console session from a remote (over Unix domain socket) terminal using the Endermux client.
+
+An example use case for this would be running the server as a systemd service and using Endermux when an interactive console is needed.
+
+## Command
+
+- `/better-fabric-console` (operator-level): Prints mod version information.
+
+## License
+
+MIT. See `license.txt`.

build.gradle.kts

@@ -2,44 +2,52 @@ import me.modmuss50.mpp.ReleaseType
 import xyz.jpenilla.resourcefactory.fabric.Environment
 
 plugins {
-  val indraVersion = "4.0.0"
-  id("net.kyori.indra") version indraVersion
-  id("net.kyori.indra.checkstyle") version indraVersion
-  id("net.kyori.indra.licenser.spotless") version indraVersion
+  alias(libs.plugins.indra)
+  alias(libs.plugins.indraCheckstyle)
+  alias(libs.plugins.indraLicenserSpotless)
   id("xyz.jpenilla.quiet-fabric-loom")
-  id("me.modmuss50.mod-publish-plugin") version "1.1.0"
-  id("xyz.jpenilla.resource-factory-fabric-convention") version "1.3.1"
+  alias(libs.plugins.modPublishPlugin)
+  alias(libs.plugins.resourceFactoryFabricConvention)
 }
 
-version = "1.3.0-SNAPSHOT"
+version = "2.0.0-SNAPSHOT"
 group = "xyz.jpenilla"
 description = "Server-side Fabric mod enhancing the console with tab completions, colored log output, command syntax highlighting, command history, and more."
 
-val minecraftVersion = "26.1-snapshot-4"
+val minecraftVersion = libs.versions.minecraft.get()
 
 dependencies {
-  minecraft("com.mojang:minecraft:$minecraftVersion")
-  implementation("net.fabricmc:fabric-loader:0.18.4")
-  implementation("net.fabricmc.fabric-api:fabric-api:0.142.1+26.1")
+  minecraft(libs.minecraft)
+  implementation(libs.fabricLoader)
+  implementation(libs.fabricApi)
 
-  annotationProcessor("org.apache.logging.log4j:log4j-core:2.25.3")
+  implementation("xyz.jpenilla:endermux-common")
+  include("xyz.jpenilla:endermux-common")
+  implementation("xyz.jpenilla:endermux-server")
+  include("xyz.jpenilla:endermux-server")
 
-  val jlineVersion = "3.30.6"
-  implementation("org.jline:jline:$jlineVersion")
-  include("org.jline:jline:$jlineVersion")
-  implementation("org.jline:jline-terminal-jansi:$jlineVersion")
-  include("org.jline:jline-terminal-jansi:$jlineVersion")
+  implementation(libs.bundles.jline)
+  include(libs.bundles.jline)
 
-  implementation("org.fusesource.jansi:jansi:2.4.2")
-  include("org.fusesource.jansi:jansi:2.4.2")
+  // Fallback in case native access flags not passed - TODO verify this works as intended
+  implementation(libs.jansi)
+  include(libs.jansi)
+  implementation(libs.jline.terminal.jansi)
+  include(libs.jline.terminal.jansi)
 
-  implementation("net.kyori:adventure-platform-fabric:6.9.0")
+  annotationProcessor(platform(libs.log4jBom))
+  annotationProcessor(libs.log4jCore)
 
-  implementation(transitiveInclude("org.spongepowered:configurate-hocon:4.2.0") {
+  implementation(libs.adventurePlatformFabric)
+
+  transitiveInclude(libs.configurateHocon) {
+    exclude("net.kyori", "option") // provided by adventure-platform-fabric
+  }
+  implementation(libs.configurateHocon) {
     exclude("net.kyori", "option") // provided by adventure-platform-fabric
-  })
+  }
 
-  compileOnly("org.jspecify:jspecify:1.0.0")
+  compileOnly(libs.jspecify)
 }
 
 indra {
@@ -63,15 +71,22 @@ fabricModJson {
   mixin("better-fabric-console.mixins.json")
   depends("fabricloader", ">=0.18.4")
   depends("fabric-api", "*")
-  depends("minecraft", ">1.21.11", "<26.2") // TODO ">=$minecraftVersion")
+  depends("minecraft", ">=$minecraftVersion", "<26.2")
   depends("adventure-platform-fabric", "*")
+  breaks("better_log4j_config", "*")
+  breaks("jline4mcdsrv", "*")
 }
 
 tasks {
   jar {
     from("LICENSE")
     archiveFileName.set("${project.name}-mc$minecraftVersion-${project.version}.jar")
   }
+  runServer {
+    // jvmArgs("-Dmixin.debug=true")
+
+    // systemProperty("better-fabric-console.log.level", "debug")
+  }
 }
 
 publishMods.modrinth {
@@ -84,4 +99,6 @@ publishMods.modrinth {
   modLoaders.add("fabric")
   requires("fabric-api")
   requires("adventure-platform-mod")
+  incompatible("better-log4j-config")
+  incompatible("jline4mcdsrv")
 }

gradle.properties

@@ -1,3 +1,4 @@
 org.gradle.jvmargs=-Xmx2G
 org.gradle.caching=true
 org.gradle.parallel=true
+org.gradle.configuration-cache=true

gradle/libs.versions.toml

@@ -0,0 +1,45 @@
+[versions]
+indra = "4.0.0"
+mod-publish-plugin = "1.1.0"
+resource-factory-fabric-convention = "1.3.1"
+
+minecraft = "26.1.2"
+fabric-loader = "0.19.2"
+fabric-api = "0.146.0+26.1.2"
+
+log4j = "2.25.3"
+jline = "3.30.6"
+jansi = "2.4.2"
+adventure-platform-fabric = "6.9.0"
+configurate-hocon = "4.2.0"
+jspecify = "1.0.0"
+
+[plugins]
+indra = { id = "net.kyori.indra", version.ref = "indra" }
+indraCheckstyle = { id = "net.kyori.indra.checkstyle", version.ref = "indra" }
+indraLicenserSpotless = { id = "net.kyori.indra.licenser.spotless", version.ref = "indra" }
+modPublishPlugin = { id = "me.modmuss50.mod-publish-plugin", version.ref = "mod-publish-plugin" }
+resourceFactoryFabricConvention = { id = "xyz.jpenilla.resource-factory-fabric-convention", version.ref = "resource-factory-fabric-convention" }
+
+[libraries]
+minecraft = { module = "com.mojang:minecraft", version.ref = "minecraft" }
+fabricLoader = { module = "net.fabricmc:fabric-loader", version.ref = "fabric-loader" }
+fabricApi = { module = "net.fabricmc.fabric-api:fabric-api", version.ref = "fabric-api" }
+
+log4jBom = { module = "org.apache.logging.log4j:log4j-bom", version.ref = "log4j" }
+log4jCore = { module = "org.apache.logging.log4j:log4j-core", version.ref = "log4j" }
+log4jApi = { module = "org.apache.logging.log4j:log4j-api", version.ref = "log4j" }
+log4jIostreams = { module = "org.apache.logging.log4j:log4j-iostreams", version.ref = "log4j" }
+
+jline = { module = "org.jline:jline", version.ref = "jline" }
+jline-terminal-ffm = { module = "org.jline:jline-terminal-ffm", version.ref = "jline" }
+jline-terminal-jansi = { module = "org.jline:jline-terminal-jansi", version.ref = "jline" }
+jansi = { module = "org.fusesource.jansi:jansi", version.ref = "jansi" }
+
+adventurePlatformFabric = { module = "net.kyori:adventure-platform-fabric", version.ref = "adventure-platform-fabric" }
+
+configurateHocon = { module = "org.spongepowered:configurate-hocon", version.ref = "configurate-hocon" }
+jspecify = { module = "org.jspecify:jspecify", version.ref = "jspecify" }
+
+[bundles]
+jline = ["jline", "jline-terminal-ffm"]

gradle/wrapper/gradle-wrapper.properties

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

settings.gradle.kts

@@ -24,10 +24,10 @@ pluginManagement {
 }
 
 plugins {
-  id("xyz.jpenilla.quiet-fabric-loom") version "1.15-SNAPSHOT" apply false
+  id("xyz.jpenilla.quiet-fabric-loom-repositories") version "1.16-SNAPSHOT"
   id("org.gradle.toolchains.foojay-resolver-convention") version "1.0.0"
 }
 
-plugins.apply(net.fabricmc.loom.LoomRepositoryPlugin::class.java)
-
 rootProject.name = "better-fabric-console"
+
+includeBuild("./endermux")