Skip to content

Commit

Permalink
Readme v 1.1.
Browse files Browse the repository at this point in the history
  • Loading branch information
gamelist1990 committed Sep 18, 2024
1 parent 644e462 commit 4021e56
Show file tree
Hide file tree
Showing 5 changed files with 47 additions and 44 deletions.
73 changes: 37 additions & 36 deletions EN_README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,55 +5,56 @@
## Download⬇️
![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/gamelist1990/ChestLockAddon/total?style=flat-square&logo=https%3A%2F%2Fgithub.com%2Fgamelist1990%2FChestLockAddon%2Fblob%2Fmain%2FAllAddon%2Fpack_icon.png%3Fraw%3Dtrue)

[Download here👈](https://github.com/gamelist1990/ChestLockAddon/releases)
[Download Here👈](https://github.com/gamelist1990/ChestLockAddon/releases)

## Update

**Version 1.0** Many behind-the-scenes updates have been made. Please refer to the changelog below for details.
[ChangeLog](https://github.com/gamelist1990/ChestLockAddon/compare/0.9...1.0)
**Version 1.1** Updated to support Minecraft Version 1.21.30
[ChangeLog](https://github.com/gamelist1990/ChestLockAddon/compare/1.0...1.1)

**Changes**
Detailed changes can be found in the ChangeLog above.
**Changes:**
For detailed changes, please refer to the ChangeLog above

Here's a brief summary of the changes:
Here is a brief summary of the changes:

- Bug fixes and feature additions. Specifically:
- Added anti-cheat to packet.ts (custom anti-cheat)
- Organized files
- Players without appropriate permissions will no longer see `Dev`/`list`/`join`/`warpgate`/`edit`/`anticheat` when using the help command
- Several new commands have been added, check the command list below for details.
- This update brings compatibility with Minecraft Version 1.21.30.
- Includes various bug fixes.
- Introduces a new feature: Staff command.
- Added a report command.

![alt text](image/EN,image.png)

## Overview

This code is an addon that is used by executing commands like `!help`. It supports UI elements; use `!item` or `!ui` to access them. The prefix `!` can be changed in `handler.ts`. The addon also supports multiple languages.
This addon is operated by executing commands such as `!help`. It supports UI elements, use `!item` or `!ui` to access them. The prefix `!` can be changed in `handler.ts`. The addon is also multilingual.

If you encounter any bugs or issues, please feel free to report them on Discord or by creating an issue.
If you encounter any bugs or issues, feel free to contact me on Discord or through Issues.

## Commands

* All commands for owners require the (OP) tag, so use `/tag @s add op`.
* **`!help`**: help command - displays a list of available commands.
* **`!chest`**: chest command - opens the chest command menu.
* **`!lang`**: Language command - changes the language setting.
* **`!dev`**: Developer command - (op)
* **`!ui`**: Added a UI command for PS4/5 users.
* **`!jpch`**: A feature that replicates LunaChat (experimental).
* **`!item`**: Obtain an item that opens the UI.
* **`!tpa`**: Send a teleport request.
* **`!list`**: Display player information (op).
* **`!anticheat`**: Usage: on|off|freeze Player |unfreeze Player (op).
* **`!lore`**: lore -set apple sets the description of the item you are holding. lore -rename test can also rename the item.
* **`!join`**: This command uses the subcommand -settings to write rules. Use (-true/-false) to toggle display (op).
* **`!warpgate`**: This command creates warp gates. Usage: `!warpgate -create gate name TP destination coordinates`. To delete: `!warpgate -delete gate name`. To display the list: `-list`.
* **`!about`**: Displays an overview of this addon.
* All owner commands require the (OP) tag, so please use `/tag @s add op`.
* **`!help`**: Displays a list of available commands.
* **`!chest`**: Opens the chest command menu.
* **`!lang`**: Changes the language setting.
* **`!dev`**: Developer command (op required).
* **`!ui`**: Added a UI command for PS4/5.
* **`!jpch`**: An experimental feature replicating LunaChat.
* **`!item`**: Obtain an item that opens the UI.
* **`!tpa`**: Send a teleport request.
* **`!list`**: Displays player information (op required).
* **`!antichat`**: Use with on|off|freeze Player |unfreeze Player (op required).
* **`!lore`**: `!lore -set apple` sets the description of the item in hand. `!lore -rename test` renames the item in hand.
* **`!join`**: Use this command with subcommand -settings to set rules. Toggle display with (-true/-false) (op required).
* **`!warpgate`**: This command allows you to create warp gates. Usage: `!warpgate -create gate_name destination_coordinates` / To delete: `!warpgate -delete gate_name` / To list gates: `-list`.
* **`!about`**: Displays information about this addon.
* **`!staff`**: This is a command specifically for staff (requires "staff" tag).
* **`!report`**: Report players who are misbehaving.

* More commands will be added in the future.

## Changing the Prefix

The command prefix can be changed in `handler.ts`.
You can change the command prefix in `handler.ts`.

## Multilingual Support

Expand All @@ -66,16 +67,16 @@ This addon supports multiple languages. Currently supported languages are:
* **`ko_KR`**: Korean (partially supported)
* **`fi_FI`**: Finnish (partially supported)

Use the **`!lang` command** to change the language.
You can change the language using the **`!lang` command**.

## How to Use

1. Download the addon from the releases page.
2. Enable the `-beta` experimental feature in Minecraft.
3. Join the world and use `!help` to view the list of commands.
4. If you are the world administrator, it is recommended to add the op tag.
1. Download the addon from the releases.
2. Enable the `-beta` experimental features in Minecraft.
3. Join a world and use `!help` to see a list of commands.
4. If you are a world administrator, it is recommended to add the "op" tag to yourself.

## Others

The language folders are located in src/command/langs/list.
(Define the translation keys in the JSON files).
Language folders are located at src/command/langs/list.
(Please define translation keys in the JSON files)
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,18 @@

## Update

**Version 1.0** 裏で色々とアップデートをしていましたが変更点は以下のログ見てね
[ChangeLog](https://github.com/gamelist1990/ChestLockAddon/compare/0.9...1.0)
**Version 1.1** MinecraftがVerison 1.21.30に更新したんで対応しました
[ChangeLog](https://github.com/gamelist1990/ChestLockAddon/compare/1.0...1.1)

**更新点**
詳細な変更点は☝のChangeLogを見てね

ここでは簡潔に変更点をまとめます

・バグ修正と機能追加を行いました。具体的には
・packet.tsのアンチチートの追加(自作アンチチート)
・ファイル内の整理
・helpコマンド使用時に適切な権限が無いプレイヤーは`Dev`/`list`/`join`/`warpgate`/`edit`/`anticheat`を表示しないようにしました
・新コマンドは色々追加したので↓のコマンド一覧から確認してください
・今回のアプデではMinecraft Version 1.21.30に対応しました
・その他バグ修正
・新機能Staffコマンド
・reportコマンドも追加しました

![alt text](image/image.png)

Expand All @@ -49,6 +48,9 @@
* **`!join`**: このコマンドはサブコマンドで-settingsを使用してルールを書けます(-true/-false)で表示の切り替え可能(op)
* **`!warpgate`**:このコマンドはワープゲートを作成できます使用方法は`!warpgate -create ゲート名 TP先の座標` /削除する場合は `!warpgate -delete ゲート名` /リスト表示は`-list`で可能です
* **`!about`**:このアドオンの概要を表示してくれます
* **`!staff`**:こスタッフ専用のコマンドです(タグ:staff必要)
* **`!report`**:悪い事をしているプレイヤーを報告できます



* その他、コマンドは今後追加予定です。
Expand Down
2 changes: 1 addition & 1 deletion devFolder/src/command/langs/list/ja_JP.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ export const translations = {
},
"command.ui.reportBody": {
msgid: "§a== Report Menu ==\n\n§l§bReporter§f:{reporter}\n\n§l§6Reported Player§f: {reportedPlayer}\n\n§l§2Reason§f: {reason}\n\n§l§gTimestamp§f: {timestamp}\n\n§a================",
msgstr: "§a== レポート メニュー ==\n\n§l§b報告者§f:{reporter}\n\n§l§6報告されたプレイヤー§f: {reportedPlayer}\n\n§l§2理由§f: {reason}\n\n§l§g報告日時§f: {timestamp}\n\n§a==================="
msgstr: "§a== レポート メニュー ==\n\n§l§b報告者§f:{reporter}\n\n§l§6報告されたプレイヤー§f: {reportedPlayer}\n\n§l§2理由§f: {reason}\n\n§l§g報告日時§f: {timestamp}\n\n§a===================="
},
"command.about": {
msgid: "§a== About ChestLockAddon ==\n\nChestLockAddon is a useful utility addon for Minecraft version 1.21.22 that provides chest protection and more.\n\n§b== Main Features ==\n• Chest Protection: Protect your chests from other players.\n• Multilingual Support: Change the language setting with the lang command.\n• Teleport Request: Send a teleport request to another player with the tpa command.\n• And more: More useful commands will be added in the future.\n\n§b== Links ==\n• GitHub: https://github.com/gamelist1990/ChestLockAddon\n• YouTube: https://www.youtube.com/@PEXkoukunn\n• Discord: https://discord.gg/GJyqBm7Pyd\n\n§c== Notes ==\nThis addon is under development and may contain unexpected bugs. If you find any bugs, please report them on GitHub or Discord.\n\n§a== Message from the Developer ==\nWe welcome your feedback to make ChestLockAddon a better addon.",
Expand Down
Binary file modified image/EN,image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified image/image.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4021e56

Please sign in to comment.