GitHub-Repo/ChatPlus
1
0
Fork 0
mirror of https://github.com/CPTProgrammer/ChatPlus.git synced 2025-05-12 23:08:13 +08:00
Code Issues Packages Projects Releases Wiki Activity
2c6471a8c0
ChatPlus/README.md
CPTProgrammer 2c6471a8c0
Update README.md
2025-04-21 05:15:42 +08:00

4.0 KiB
Raw Blame History

Chat Plus

Static Badge

A simple Fabric mod that adds Bukkit-style color codes (using "&") and "[item]" display in chat.

It can be installed on the client or server:

  • Install on the server only if you want players to send styled messages in-game
  • Install on the host client (the one creating the LAN multiplayer session) for LAN multiplayer functionality
  • Install on the client for single-player functionality

Compatibility has been implemented for these mods: Styled Chat, Dynmap
* Other mods may work without explicit support. Report compatibility requests via GitHub Issues.

Screenshots

image
^^^ Display the item in the main hand

image
^^^ Colorful Text

image
^^^ Display items in slots

image
^^^ Escape character &

Minecraft Versions

Development Version Compatible Versions
1.19 1.19
1.19.1 1.19.1 - 1.19.2
1.19.3 1.19.3 - 1.19.4
1.20 1.20 - 1.20.2
1.20.3 1.20.3 - 1.20.6
1.21 1.21 - 1.21.5

Development

Environment

  • Java 21 or higher
  • (Optional) Java IDE with Manifold support (e.g., IntelliJ IDEA)
    * If using IntelliJ IDEA, the Manifold plugin should be installed

Switching Versions

Set minecraft_version in gradle.properties, or append -Pmc=x.x.x parameter to Gradle commands (e.g., ./gradlew build -Pmc=1.20.3) to switch Minecraft versions for development.

Note for IDE users:

After modifying gradle.properties or ./properties/*.properties, remember to reload the Gradle project (or click "Load Gradle Changes" button)

Cross-version Testing

To test mod compatibility with newer Minecraft versions:

  • Method 1:
    • Set minecraft_version to target version, and configure matching test_fabric_api_version (e.g., 0.121.0+1.21.5)
    • Reload project to download dependencies (for IDE users)
    • Place additional test mods in ./run/mods
    • Run Gradle task runClient or runServer (May encounter unexpected launch issues - if this occurs, try Method 2)
  • Method 2: Build JAR file and deploy to mods folder of the target Minecraft version client/server

Note:

The minecraft_version can be a version not explicitly listed in ./properties/*.properties files. The settings.gradle script will automatically select the nearest compatible properties configuration.

Build

Run one of the following commands to build the JAR:

# Build the JAR for the currently configured Minecraft version
./gradlew build  # Windows: .\gradlew build

# Build for a different Minecraft version, e.g.
./gradlew build -Pmc=1.20.3

To build JARs for all Minecraft versions defined in ./properties:

./gradlew buildAll  # Windows: .\gradlew buildAll

Note:

All compiled JARs are output to ./build/libs

Contributors

Special Thanks