# Custom Katana

C**ustomizable** via the config file and **client shared file is open source** for easy integration with custom frameworks or inventory systems.

**Preview:** [**https://youtu.be/f2sqSYQZFmM**](https://youtu.be/f2sqSYQZFmM)\
\
**Key Features:**

* 🗡️ **Custom Katana Weapons**\
  Four unique katana styles, available in **Red, Blue, Grey, and Yellow**.
* ⚔️ **Multi Style Support**\
  Equip **two katanas** of different colors simultaneously for extra flair.
* ✨ **Visual Particle Effects**\
  Each katana comes with its **own particle effect**.
* 🚗 **Immersive Visuals**
  * Models are **hidden inside vehicles** to prevent clipping issues.
  * Models can be **hidden manually via item use**.
* 🛡️ **Weapon Ready Functionality**\
  The katana can be used as a weapon. When drawn, it appears in hand.
* ⚙️ **Configurable**
  * Enable or disable features like particle FX and dual wielding.
* ⚙️ **Customizable**: Designed for flexibility, the script works with any framework or inventory system. By default, it’s set for *qb-core* and *ox\_inventory*. Need help? Reach out on our Discord!\ <br>

#### **Supported Frameworks**&#x20;

✅ **Framework Compatibility:** QBOX / QB-Core / ESX / Custom\
(*Designed to be mostly standalone, with minimal framework dependencies in server-side files.*)

✅ **Inventory Support:** QB-Inventory / OX-Inventory / Custom\
(*Includes built-in support for QB and OX inventories, with an option to integrate your own custom system.*)\
\
**Important**:\
⚠️ **All server, client (without client\_shared) files for this script are escrowed**. However, **client\_shared file is open source**, and the script is designed to be easily edited for integration with your server’s custom framework or inventory system.⚠️\
\
For Any More Question Regarding The Script Join Our [Discord](https://discord.com/invite/PeDmabgehk)!


---

# Agent Instructions: 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:

```
GET https://corelogic-development.gitbook.io/corelogic-development/scripts/custom-katana.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.