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

# 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)!
