mirror of
https://github.com/CPTProgrammer/ChatPlus.git
synced 2026-09-19 23:23:38 +08:00
Rewrite entire project for v1.0.0
- Remove legacy code and replace with new implementation - Update version to 1.0.0 - Adjust build configurations and dependencies.
This commit is contained in:
@@ -1,24 +1,113 @@
|
||||
# ChatPlus
|
||||

|
||||
# Chat Plus
|
||||
|
||||

|
||||
<a href="https://modrinth.com/mod/chatplus">
|
||||
<img src="https://img.shields.io/badge/Modrinth-Chat_Plus-%234e910e?style=flat" />
|
||||
</a>
|
||||
|
||||
A Simple mod add bukkit style with an "&" and "[item]" display for Fabric Server.
|
||||
|
||||
It's a **server-side** mod and doesn't need to be installed on the client.
|
||||
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<br>
|
||||
_* Other mods may work without explicit support. Report compatibility requests via [GitHub Issues](https://github.com/CPTProgrammer/ChatPlus)._
|
||||
|
||||
## Screenshots
|
||||
|
||||

|
||||
**^^^ Display the item in main hand**
|
||||
**^^^ Display the item in the main hand**
|
||||
|
||||

|
||||
**^^^ Colorful Text**
|
||||
**^^^ Colorful Text**
|
||||
|
||||

|
||||
**^^^ Display items in slots**
|
||||
**^^^ Display items in slots**
|
||||
|
||||
**^^^ 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 23 or higher
|
||||
- (Optional) Java IDE with Manifold support (e.g., IntelliJ IDEA)<br>
|
||||
_* 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:
|
||||
|
||||
```bash
|
||||
# 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`:
|
||||
|
||||
```bash
|
||||
./gradlew buildAll # Windows: .\gradlew buildAll
|
||||
```
|
||||
|
||||
> **Note:**
|
||||
>
|
||||
> All compiled JARs are output to `./build/libs`
|
||||
|
||||
|
||||
|
||||
## Contributors
|
||||
|
||||
<a href="https://github.com/CPTProgrammer/ChatPlus/graphs/contributors">
|
||||
<img src="https://contrib.rocks/image?repo=CPTProgrammer/ChatPlus" />
|
||||
</a>
|
||||
|
||||
#### Special Thanks
|
||||
|
||||
- [@SAGUMEDREAM](https://github.com/SAGUMEDREAM) for advice on mixin development.
|
||||
- [Distant-Horizons-Team/Distant Horizons](https://gitlab.com/distant-horizons-team/distant-horizons/) for inspiring the build configuration design.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user