From cad150e96cf12158570dfb106c06f7b65b19a839 Mon Sep 17 00:00:00 2001 From: Lux Solari Date: Thu, 2 Jul 2026 17:31:17 -0300 Subject: [PATCH] fix: rename artifactId from java-packageable-base, docs cleanup Fresh-eyes review, same process applied to sage-instructor, three-axes-framework, lux-solari-plugins, and claude-trip-computer. pom.xml's artifactId was still literally "java-packageable-base" -- the name of a different template repo this one was bootstrapped from -- referenced consistently (if consistently wrong) across pom.xml, README.md, CLAUDE.md, docs/DEVELOPER_GUIDE.md, and .github/copilot-instructions.md. Renamed to "console-jack" everywhere. The packaging profiles (windows/mac/linux) all reference ${project.build.finalName}, so this was a safe, single-point change that propagates correctly to the jpackage build outputs. Also fixed: - placeholder never filled in, in README's clone instructions. - Root README linked to a nonexistent docs/CLAUDE.md -- CLAUDE.md lives at repo root; pointed to docs/README.md's index instead, which already links it correctly. - docs/README.md's own documentation index was missing 5 of the 13 files actually in that folder (AUDIO_SYSTEM_GUIDE, ECS_GUIDE, INPUT_SYSTEM_GUIDE, RENDERING_GUIDE, STATE_MACHINE_GUIDE) -- added over time, never indexed. - Added a license badge to README. GitHub topics added separately for discoverability. Co-Authored-By: Claude Sonnet 5 --- .github/copilot-instructions.md | 2 +- CLAUDE.md | 2 +- README.md | 8 +++++--- docs/DEVELOPER_GUIDE.md | 4 ++-- docs/README.md | 5 +++++ pom.xml | 2 +- 6 files changed, 15 insertions(+), 8 deletions(-) diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 89595e6..002fddb 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -108,7 +108,7 @@ public class DisplayListSystem implements EcsSystem { mvn compile # Compile only mvn exec:java # Run during development mvn clean package # Build JAR with dependencies -java -jar target/java-packageable-base-1.0-SNAPSHOT-jar-with-dependencies.jar +java -jar target/console-jack-1.0-SNAPSHOT-jar-with-dependencies.jar ``` ### Platform Packaging diff --git a/CLAUDE.md b/CLAUDE.md index 16a026b..f7be4b2 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -13,7 +13,7 @@ Console Jack is a console-based, text-graphics implementation of the classic cas - `mvn compile` - Compile the project - `mvn exec:java` - Run the application directly - `mvn clean package` - Build JAR with dependencies -- `java -jar target/java-packageable-base-1.0-SNAPSHOT-jar-with-dependencies.jar` - Run the packaged JAR +- `java -jar target/console-jack-1.0-SNAPSHOT-jar-with-dependencies.jar` - Run the packaged JAR ### Platform-Specific Packaging diff --git a/README.md b/README.md index f9b4091..e28adf5 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Console Jack +[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE) + Console-based, text-graphics implementation of the classic casino blackjack game. Aims to be a "Card RPG" of sorts where you start a career as a frequent player at a local casino, and "move up the ranks" to the top-tier casinos of the world. All of that, in ASCII text-graphics, terminal-emulator-driven glory. @@ -25,7 +27,7 @@ Currently in semi-active development (_read: I have a day job, so I work on this ### Running the Game ```bash # Clone and build -git clone +git clone https://github.com/luxsolari/console-jack cd console-jack mvn compile @@ -39,7 +41,7 @@ mvn exec:java mvn clean package # Run the packaged version -java -jar target/java-packageable-base-1.0-SNAPSHOT-jar-with-dependencies.jar +java -jar target/console-jack-1.0-SNAPSHOT-jar-with-dependencies.jar ``` ## Tech Stack @@ -109,4 +111,4 @@ src/main/java/net/luxsolari/ 3. Test changes with `mvn exec:java` 4. Verify build with `mvn clean package` -See `docs/IMPROVEMENT_PLAN.md` for planned enhancements and `docs/CLAUDE.md` for detailed development guidance. +See [`docs/README.md`](docs/README.md) for the full documentation index — architecture, engine guides, and `CLAUDE.md` for AI-assistant development guidance. diff --git a/docs/DEVELOPER_GUIDE.md b/docs/DEVELOPER_GUIDE.md index 9c6e509..ac1ac60 100644 --- a/docs/DEVELOPER_GUIDE.md +++ b/docs/DEVELOPER_GUIDE.md @@ -47,7 +47,7 @@ mvn clean compile mvn clean package # Test the packaged version -java -jar target/java-packageable-base-1.0-SNAPSHOT-jar-with-dependencies.jar +java -jar target/console-jack-1.0-SNAPSHOT-jar-with-dependencies.jar ``` ## Build Commands Reference @@ -69,7 +69,7 @@ mvn exec:java -Dexec.args="--debug" # Pass arguments ```bash mvn package # Create JAR with dependencies mvn clean package # Clean build -java -jar target/java-packageable-base-1.0-SNAPSHOT-jar-with-dependencies.jar +java -jar target/console-jack-1.0-SNAPSHOT-jar-with-dependencies.jar ``` ### Platform-Specific Builds diff --git a/docs/README.md b/docs/README.md index b389e33..dc5f4f0 100644 --- a/docs/README.md +++ b/docs/README.md @@ -9,6 +9,11 @@ This directory contains all project documentation for Console Jack. - **[RIPER_MODE.md](RIPER_MODE.md)** - RIPER-5 mode strict operational protocol - **[DEVELOPER_GUIDE.md](DEVELOPER_GUIDE.md)** - Comprehensive development guide - **[ARCHITECTURE.md](ARCHITECTURE.md)** - Detailed architecture documentation +- **[ECS_GUIDE.md](ECS_GUIDE.md)** - Entity Component System guide +- **[RENDERING_GUIDE.md](RENDERING_GUIDE.md)** - Rendering system guide +- **[INPUT_SYSTEM_GUIDE.md](INPUT_SYSTEM_GUIDE.md)** - Input system guide +- **[AUDIO_SYSTEM_GUIDE.md](AUDIO_SYSTEM_GUIDE.md)** - Audio system guide +- **[STATE_MACHINE_GUIDE.md](STATE_MACHINE_GUIDE.md)** - State machine guide - **[UI_COMPONENTS_GUIDE.md](UI_COMPONENTS_GUIDE.md)** - UI component framework reference - **[IMPROVEMENT_PLAN.md](IMPROVEMENT_PLAN.md)** - Planned enhancements and technical debt diff --git a/pom.xml b/pom.xml index bd35aee..96e39c3 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ 4.0.0 net.luxsolari - java-packageable-base + console-jack 1.0-SNAPSHOT