> For the complete documentation index, see [llms.txt](https://kbanimation.gitbook.io/kbanimation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kbanimation.gitbook.io/kbanimation/home.md).

# HOME

{% tabs %}
{% tab title="EN" %}

## 🎯 KbAnimation Wiki

**First-Person 3D Weapon Animation & HUD Addon for WeaponMechanics**

KbAnimation is an all-in-one Minecraft plugin that brings TACZ/Call of Duty-style first-person 3D weapon animations and a fully-featured HUD system to servers running WeaponMechanics. It utilizes BetterModel for rendering Blockbench models in-game and BetterHud for displaying ammo counters, crosshairs, fire mode indicators, damage direction arrows, hit markers, kill feed, and weapon stat bars.

> ⚡ **Version:** 1.0-SNAPSHOT | **API:** 1.21+

### ✨ Core Features

* **3D Animation System:** Handles equip, standing (idle), sprint, reload, hip-fire, ADS-aiming, ADS-shoot, inspect, melee, and unequip animations directly from Blockbench Generic Models.
* **Attachment System:** Visual attachment toggling (shows/hides model bones), conflict groups, and an in-game customization overlay.
* **BetterHud & PAPI:** Custom native HUD overlays, crosshairs, direction indicators, damage direction markers, and PvP/PvE Kill Feeds.

### 📖 Wiki Sections

Use the sidebar navigation or links below to explore the sections:

1. [Requirements & Installation](/kbanimation/installation.md) - Server setup, required dependencies.
2. [3D Model Creation Workflow](broken://pages/5830200bd485833ae2a96da25922033da58c691b) - Designing weapons and animations in Blockbench.
3. [Weapon Model Configuration](/kbanimation/model-config.md) - Configuring animations and scales in YML files.
4. [Attachment System](/kbanimation/attachments.md) - Attachment bone maps, speed scaling, customization screen.
5. [Visual Effects](/kbanimation/effects.md) - Muzzle flashes, bullet holes, and melee slash marks.
6. [Main Configuration](/kbanimation/plugin-config.md) - Main plugin config.yml reference.
7. [BetterHud Integration](/kbanimation/hud-setup.md) - Native placeholders, layout parameters, UI variables.
8. [Commands & Permissions](/kbanimation/commands.md) - Administrator commands and permission node map.
9. [Language & Translation](/kbanimation/language.md) - Setting up custom translations and message keys.
10. [FAQ & Troubleshooting](/kbanimation/q-and-a.md) - Solution guide for common issues.
    {% endtab %}

{% tab title="TH" %}

## 🎯 ยินดีต้อนรับสู่คู่มือ KbAnimation

**ปลั๊กอินแอนิเมชันอาวุธ 3 มิติมุมมองบุคคลที่หนึ่ง และระบบ HUD สำหรับ WeaponMechanics**

KbAnimation เป็นปลั๊กอิน Minecraft ตัวช่วยอัปเกรดเซิร์ฟเวอร์แนวปืน ให้มีแอนิเมชันแบบมุมมองบุคคลที่หนึ่ง (สไตล์ TACZ / Call of Duty) และมีระบบ HUD เต็มรูปแบบ โดยปลั๊กอินใช้ **BetterModel** ในการเรนเดอร์โมเดลจาก Blockbench เข้าไปในเกม และใช้งานร่วมกับ **BetterHud** ในการโชว์จำนวนกระสุน, เป้าเล็งปืน (Crosshair), แสดงโหมดการยิง, แสดงทิศทางที่โดนยิง, เป้ากระพริบเวลายิงโดน (Hit Marker), การแจ้งเตือนฆ่า (Kill Feed) และแถบพลังความแรงปืนขณะแต่งปืน

> ⚡ **เวอร์ชัน:** 1.0-SNAPSHOT | **รองรับ API:** 1.21+

### ✨ คุณสมบัติหลัก (Core Features)

* **ระบบแอนิเมชัน 3 มิติ:** รองรับท่าดึงปืน (equip), ท่ายืนถือปืน (standing), ท่าวิ่ง (sprint), ท่าบรรจุกระสุน (reload), ท่ายิงปกติ, ท่าเล็งยิง (ADS), ท่าตรวจสอบปืน (inspect), ท่าฟันมีด (melee) และท่าเก็บปืน (unequip)
* **ระบบแต่งปืนแบบสมจริง (Attachment System):** ซ่อนหรือแสดงชิ้นส่วนกระดูก (Bones) บนปืนตามของแต่งที่ใส่จริง, มีโหมดแต่งปืนกลางหน้าจอ (Customization mode) พร้อมระบบล็อกการเคลื่อนที่
* **ระบบแสดงผล HUD (BetterHud & PAPI):** เป้าเล็งแบบเงื่อนไข (ซ่อนเมื่อเล็งซูม), แสดงทิศทางกระสุนที่ยิงโดนตัวเรา, แสดงไอคอนโหมดการยิง Auto/Burst/Semi, ระบบแจ้งเตือนการคิล

### 📖 สารบัญคู่มือการใช้งาน

เลือกหัวข้อจากเมนูด้านซ้าย หรือกดเข้าชมจากรายการด้านล่างนี้:

1. [การติดตั้งและสิ่งที่จำเป็น (Installation)](/kbanimation/installation.md) - ตรวจสอบความต้องการระบบและปลั๊กอินที่ต้องใช้ร่วมกัน
2. [การทำโมเดล 3 มิติ (Model Creation)](broken://pages/5830200bd485833ae2a96da25922033da58c691b) - การสร้างปืนและออกแบบท่าแอนิเมชันใน Blockbench
3. [การตั้งค่าโมเดลอาวุธ (Model Config)](/kbanimation/model-config.md) - อธิบายไฟล์ตั้งค่าปืนแต่ละกระบอกในโฟลเดอร์ models
4. [ระบบแต่งปืน (Attachment System)](/kbanimation/attachments.md) - วิธีกำหนดชิ้นส่วนของแต่ง, ความเร็วแอนิเมชัน และปุ่มควบคุมโหมดแต่งปืน
5. [เอฟเฟกต์ภาพ (Visual Effects)](/kbanimation/effects.md) - ตั้งค่าแสงไฟปากกระบอกปืน, รอยกระสุนเกาะบล็อก และรอยฟันดาบกลางอากาศ
6. [การตั้งค่าหลัก (Main Config)](/kbanimation/plugin-config.md) - รายละเอียดในไฟล์ config.yml ของปลั๊กอินหลัก
7. [การเชื่อมโยงกับ BetterHud (HUD Setup)](/kbanimation/hud-setup.md) - ตัวแปร (Placeholders) ทั้งหมดที่นำไปแต่ง UI รวมถึงตัวอย่างไฟล์ HUD
8. [คำสั่งและสิทธิ์การใช้งาน (Commands & Perms)](/kbanimation/commands.md) - รายชื่อคำสั่งแอดมินและการจำกัดสิทธิ์ผู้เล่น
9. [ระบบภาษาไทย/EN (Language System)](/kbanimation/language.md) - วิธีแก้ไขข้อความแจ้งเตือนต่างๆ ให้รองรับหลายภาษา
10. [คำถามที่พบบ่อยและวิธีแก้ไข (FAQ)](/kbanimation/q-and-a.md) - รวบรวมแนวทางแก้ไขปัญหาต่างๆ เช่น โมเดลสั่นเวลาย่อ, บั๊กโหมดไฟ เป็นต้น
    {% endtab %}
    {% endtabs %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://kbanimation.gitbook.io/kbanimation/home.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.