# Home

## KXAPI - Extended Kotlin API for BotWithUs

![KXAPI Logo](https://img.shields.io/badge/KXAPI-Extended%20Kotlin%20API-blue?style=for-the-badge\&logo=kotlin)

[![Kotlin Version](https://img.shields.io/badge/kotlin-2.2.0-blue.svg)](https://kotlinlang.org/) [![JVM Target](https://img.shields.io/badge/JVM-24-green.svg)](https://openjdk.java.net/) [![Version](https://img.shields.io/badge/version-0.1--SNAPSHOT-orange.svg)](https://github.com/botwithus/kxapi) ![License](https://img.shields.io/badge/license-MIT-blue.svg) [![Lines of Code](https://img.shields.io/endpoint?url=https://ghloc.vercel.app/api/BotWithUs/BWU-V2-XAPI-KT/badge\&color=blueviolet\&label=Lines%20of%20Code)](https://github.com/BotWithUs/BWU-V2-XAPI-KT)

**A powerful, intuitive, and extensible Kotlin DSL framework for BotWithUs RuneScape 3 bot development**

🚀 Quick Start • 📚 Documentation • 💡 Examples • 🏗️ Architecture • 🤝 Contributing

***

### 🌟 What is KXAPI?

KXAPI (Kotlin eXtended API) is a comprehensive framework that extends the BotWithUs API with powerful Kotlin DSLs, making RuneScape 3 bot development more intuitive, maintainable, and enjoyable. Built with modern Kotlin features and coroutines, KXAPI provides a fluent, type-safe interface for building sophisticated bots.

#### ✨ Key Features

* **🎨 ImGui DSL**: Fluent, type-safe UI building with clean, readable syntax
* **⚡ Suspendable Scripts**: Coroutine-based scripting with `suspend` functions
* **🎯 Skilling Framework**: Comprehensive production and skilling management
* **🔍 Query DSL**: Powerful game object querying and interaction
* **🛡️ Permissive Scripting**: State-based script management with error recovery
* **📦 Inventory Management**: Enhanced backpack and bank operations
* **🔧 Utility Extensions**: String matching, component extensions, and more

***

### 🤝 Contributing

We welcome contributions! Whether you're fixing bugs, adding features, or improving documentation, your help makes KXAPI better for everyone.

#### Ways to Contribute

* 🐛 **Report Issues**: Found a bug? Let us know!
* 💡 **Feature Requests**: Have an idea? We'd love to hear it!
* 📝 **Documentation**: Help others learn with better docs
* 🔧 **Code**: Submit pull requests for improvements
* 🧪 **Testing**: Help us ensure quality and reliability

#### Getting Started

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Submit a pull request

See our Contributing Guide for detailed information.

***

### 📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

***

### 🔗 Links

* **📁 Source Code**: [GitHub Repository](https://github.com/BotWithUs/BWU-V2-XAPI-KT)
* **🐛 Issues**: [GitHub Issues](https://github.com/BotWithUs/BWU-V2-XAPI-KT/issues)
* **💬 Discussions**: [GitHub Discussions](https://github.com/BotWithUs/BWU-V2-XAPI-KT/discussions)
* **🌐 BotWithUs**: [Official Website](https://botwithus.net)
* **📚 Documentation**: [Wiki Home](https://github.com/BotWithUs/BWU-V2-XAPI-KT/wiki)

***

**Made with ❤️ by the BotWithUs team**

*Empowering developers to create amazing RuneScape 3 bots with modern Kotlin*


---

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

```
GET https://kxapi.gitbook.io/kxapi/readme.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.