port from 1.20.1

Leawind · Dec 9, 2024 · 69ebc5d · 69ebc5d
1 parent 4223ad0
commit 69ebc5d
Show file tree

Hide file tree

Showing 174 changed files with 8,415 additions and 8,230 deletions.
diff --git a/.editorconfig b/.editorconfig
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,5 +1,20 @@
 # Contributing
 
-Welcome contributions!
+* Use google-java-format
 
-According to Github Community Standards I put this file here.
+## How to add a new config item
+
+Define config item in class `AbstractConfig`
+
+```java
+public abstract class AbstractConfig {
+  @Expose public double my_option = 0.5;
+}
+
+```
+
+Use the config item somewhere.
+
+Find all screen builders in `ConfigScreenBuilder#builders`, and add the config item to the builder.
+
+Add translation to `resource/assets/minecraft/lang/*.json`
diff --git a/LICENSE.txt b/LICENSE.txt
@@ -1,5 +1,7 @@
 The MIT License (MIT)
-Copyright (c) 2023 Leawind
+
+Copyright (c) 2023-2024 Leawind (Username) <[email protected]>
+
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights

diff --git a/README-ZH.md b/README-ZH.md
@@ -3,31 +3,50 @@
 | [English](./README.md) | 中文 |
 |------------------------|----|
 
-[![](https://img.shields.io/curseforge/dt/930880?style=flat&logo=curseforge&color=F1643%5E&cacheSeconds=3600&label=下载量)](https://www.curseforge.com/minecraft/mc-mods/leawind-third-person)
-[![](https://img.shields.io/modrinth/dt/S3D3QF0M?style=flat&logo=modrinth&color=17B85A&cacheSeconds=3600&label=下载量)](https://modrinth.com/mod/leawind-third-person)
+[![CurseForge下载量](https://img.shields.io/curseforge/dt/930880?style=flat&logo=curseforge&color=F1643%5E&cacheSeconds=3600&label=下载量)](https://www.curseforge.com/minecraft/mc-mods/leawind-third-person)
+[![Modrinth下载量](https://img.shields.io/modrinth/dt/S3D3QF0M?style=flat&logo=modrinth&color=17B85A&cacheSeconds=3600&label=下载量)](https://modrinth.com/mod/leawind-third-person)
 
-[![](https://img.shields.io/github/last-commit/LEAWIND/Third-Person?logo=github&label=上次提交)](https://github.com/LEAWIND/Third-Person)
-[![](https://img.shields.io/github/deployments/LEAWIND/Third-Person/github-pages?style=flat&logo=github&label=文档&cacheSeconds=900)](https://leawind.github.io/Third-Person/en-US/?autolang)
-
-</div>
+[![Codacy Badge](https://img.shields.io/codacy/grade/41e70a17218c4773aefb62382b9547a6?logo=codacy&label=代码质量)](https://app.codacy.com/gh/Leawind/Third-Person/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![Stars](https://img.shields.io/github/stars/LEAWIND/Third-Person?style=flat&logo=github&color=daaa3f&label=星标)](https://github.com/LEAWIND/Third-Person)
 
+[![上次提交](https://img.shields.io/github/last-commit/LEAWIND/Third-Person?logo=github&label=上次提交)](https://github.com/LEAWIND/Third-Person)
 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?label=开源协议)](https://github.com/LEAWIND/Third-Person?tab=MIT-1-ov-file)
-[![Stars](https://img.shields.io/github/stars/LEAWIND/Third-Person?style=flat&logo=github&color=daaa3f&label=星标)](https://github.com/LEAWIND/Third-Person)
+[![文档](https://img.shields.io/github/deployments/LEAWIND/Third-Person/github-pages?style=flat&logo=github&label=文档&cacheSeconds=900)](https://leawind.github.io/Third-Person/en-US/?autolang)
 
 # Leawind 的第三人称
 
-为所有MC玩家打造的一个实用、丝滑、功能丰富的第三人称模组。
-
-* **精准射击：** 在第三人称下瞄准远处敌人，模组智能预测目标实体，你只需要像第一人称一样将准星放在目标上方。
-
-* **智能瞄准模式：** 根据手持物品判断是否进入瞄准模式，如使用弓、三叉戟或手持上弦的弩等，规则可自定义以兼容其他模组。
+一个实用、丝滑、功能丰富的第三人称模组。
 
-* **流畅切换视角：** 按 F5 平滑切换第一人称和第三人称视角。
-
-* **个性化相机调整：** 按住 Z，通过鼠标移动和滚轮调整相机位置。
-
-* **快速切换视角位置：** 短按CapsLock即可左右切换，长按CapsLock切换到居中。
+</div>
 
-* **玩家半透明：** 在相机距离较近或准星指向玩家时让玩家实体变得半透明。
+* **纯客户端** 不需要在服务端安装此模组，因此可以在服务器中使用
+* **自由转动视角** 视角可以自由转动，同时保持玩家身体不动。
+* **自由调整相机位置**
+	* 按住 `Z` 时，移动鼠标可以调整相机偏移量（玩家在屏幕上的位置），鼠标滚轮可以调整相机到玩家的距离
+	* **快速切换相机偏移位置（左|中|右）** 短按 `CapsLock` 可切换左右，按住 `CapsLock` 可以切换到居中
+* **智能瞄准模式** 根据玩家手持物品和使用状态自动切换到瞄准模式。规则可自定义以兼容其他模组的物品
+* **类似第一人称的射击** 第三人称下瞄准远处的敌人时，模组会自动预测你想要射击的目标实体，你只需要像第一人称那样将准星放在敌人上方即可
+* **玩家半透明** 当玩家实体阻挡视线时，会变得半透明（可能不兼容 Sodium，默认禁用此功能）
+* **平滑切换视角** 在第一/第三人称视角间平滑过渡
+* **随时禁用** 如果此模组引发了故障，你随时可以在游戏中通过配置界面或快捷键来禁用此模组，恢复成原版第三人称视角
 
-* **切换模组是否启用：** 可以使用按键绑定该操作。
+<div align=center>
+<details>
+<summary>捐赠</summary>
+
+<img alt=ΨQ src="https://github.com/Leawind/Third-Person/raw/gh-pages/docs/public/donate/IHY-216.jpg" width=648/>
+
+> <details>
+> <summary>通过微信捐赠</summary>
+> <img alt=wechat src="https://github.com/Leawind/Third-Person/raw/gh-pages/docs/public/donate/wechat.jpg" width=320 />
+> </details>
+> <details>
+> <summary>其他方式</summary>
+>
+> [Buy Me a Coffee](https://www.buymeacoffee.com/leawind)  
+> [爱发电](https://afdian.com/a/Leawind)
+>
+> </details>
+
+</details>
+</div>
diff --git a/README.md b/README.md
@@ -3,31 +3,56 @@
 | English | [中文](./README-ZH.md) |
 |---------|----------------------|
 
-[![](https://img.shields.io/curseforge/dt/930880?style=flat&logo=curseforge&color=F1643%5E&cacheSeconds=3600&label=Downloads)](https://www.curseforge.com/minecraft/mc-mods/leawind-third-person)
-[![](https://img.shields.io/modrinth/dt/S3D3QF0M?style=flat&logo=modrinth&color=17B85A&cacheSeconds=3600&label=Downloads)](https://modrinth.com/mod/leawind-third-person)
+[![CurseForge downloads](https://img.shields.io/curseforge/dt/930880?style=flat&logo=curseforge&color=F1643%5E&cacheSeconds=3600&label=Downloads)](https://www.curseforge.com/minecraft/mc-mods/leawind-third-person)
+[![Modrinth downloads](https://img.shields.io/modrinth/dt/S3D3QF0M?style=flat&logo=modrinth&color=17B85A&cacheSeconds=3600&label=Downloads)](https://modrinth.com/mod/leawind-third-person)
 
-[![](https://img.shields.io/github/last-commit/LEAWIND/Third-Person?logo=github)](https://github.com/LEAWIND/Third-Person)
-[![](https://img.shields.io/github/deployments/LEAWIND/Third-Person/github-pages?style=flat&logo=github&label=Documentation&cacheSeconds=900)](https://leawind.github.io/Third-Person/en-US/?autolang)
-
-</div>
+[![Codacy Badge](https://img.shields.io/codacy/grade/41e70a17218c4773aefb62382b9547a6?logo=codacy)](https://app.codacy.com/gh/Leawind/Third-Person/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![Stars](https://img.shields.io/github/stars/LEAWIND/Third-Person?style=flat&logo=github&color=daaa3f)](https://github.com/LEAWIND/Third-Person)
 
+[![Last commit](https://img.shields.io/github/last-commit/LEAWIND/Third-Person?logo=github)](https://github.com/LEAWIND/Third-Person)
 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/LEAWIND/Third-Person?tab=MIT-1-ov-file)
-[![Stars](https://img.shields.io/github/stars/LEAWIND/Third-Person?style=flat&logo=github&color=daaa3f)](https://github.com/LEAWIND/Third-Person)
+[![Documentation](https://img.shields.io/github/deployments/LEAWIND/Third-Person/github-pages?style=flat&logo=github&label=Documentation&cacheSeconds=900)](https://leawind.github.io/Third-Person/en-US/?autolang)
 
 # Leawind's Third Person
 
 A practical, smooth, feature-rich third person mod for all Minecraft players.
 
-* **Precision Shooting:** Aim at distant enemies in third-person, and the mod intelligently predicts the target entity. Simply put your crosshair above the target, similar to first-person.
-
-* **Smart Aim Mode:** Automatically enters aiming mode based on held items, such as bows, tridents, or loaded crossbows. Rules are customizable to suit other mods.
-
-* **Smooth Perspective Switching:** Press F5 to smoothly transition between first-person and third-person views.
-
-* **Camera Adjustment:** Hold Z and use the mouse to move or scroll to adjust the camera's position.
-
-* **Quick Perspective Shifts:** Short press of CapsLock for left or right shifts, long press for centering.
+</div>
 
-* **Player Transparency:** Player entity becomes semi-transparent when the camera is close or the crosshair is aimed at the player. (Not compatible with Sodium)
+* **Client Side Only** No need to install on server. So you can join servers with this mod.
+* **Free Rotation** Freely rotate the view while keeping the player's body stationary.
+* **Free Adjustment of Camera Position**
+	* While holding `Z`, moving the mouse adjusts the camera offset (the player's position on the screen), and the mouse
+	  wheel adjusts the distance between the camera and the player
+	* **Quick Switching of Camera Offset (Left|Center|Right)** Short press `CapsLock` to toggle between left and right.
+	  Hold `CapsLock` to center the camera
+* **Smart Aim Mode** Automatically switches to aim mode based on the item the player is holding and its using status.
+  Rules can be customized. So it can be compatible with items from other mods
+* **Shooting like first-person** When aiming at enemies in third-person, it predicts the target entity you want to shoot
+  at, allowing you to simply place the crosshair above the enemy as if in first-person
+* **Player Transparency** When the player entity obstructs the view, it becomes semi-transparent (May not be compatible
+  with Sodium. This feature is disabled by default)
+* **Smooth Perspective Switching** Smooth transition between first and third person perspectives
+* **Disable Anytime** If the mod causes issues, you can disable it anytime in-game through the configuration menu or
+  hotkey, reverting to the original third-person perspective
 
-* **Toggle mod enable/disable：** Key binding is also available.
+<div align=center>
+<details>
+<summary>Donates</summary>
+
+<img alt=ΨQ src="https://github.com/Leawind/Third-Person/raw/gh-pages/docs/public/donate/IHY-216.jpg" width=648/>
+
+> <details>
+> <summary>Donate using Wechat</summary>
+> <img alt=wechat src="https://github.com/Leawind/Third-Person/raw/gh-pages/docs/public/donate/wechat.jpg" width=320 />
+> </details>
+> <details>
+> <summary>Other ways</summary>
+>
+> [Buy Me a Coffee](https://www.buymeacoffee.com/leawind)  
+> [Afdian (爱发电)](https://afdian.com/a/Leawind)
+>
+> </details>
+
+</details>
+</div>