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

# ClassLib

<div align="left" data-full-width="false"><img src="https://img.shields.io/github/v/release/Timmy-the-nobody/ClassLib" alt=""> <img src="https://img.shields.io/github/stars/Timmy-the-nobody/ClassLib" alt=""> <img src="https://img.shields.io/github/license/Timmy-the-nobody/ClassLib" alt=""> <img src="https://img.shields.io/github/languages/top/Timmy-the-nobody/ClassLib" alt=""></div>

***

## **Overview**

**ClassLib** is a powerful Lua Object-Oriented Programming (OOP) library designed with a specific focus on emulating the behavior of [nanos world](https://nanos.world/)'s class library. Whether you are an experienced nanos world scripter or new to Lua OOP, **ClassLib** provides a familiar environment to streamline your scripting experience.

The library stands as a robust and feature-rich OOP framework tailored for nanos world. The primary objective is to offer a seamless transition for scripters accustomed to nanos world's scripting API, ensuring a smooth and painless integration into their workflow.

***

## **Key Features**

* **Lua OOP Framework**
  * **ClassLib** is built upon Lua's Object-Oriented Programming paradigm, providing a structured and efficient way to organize code.
* #### **Nanos World Compatibility**
  * Developed specifically for nanos world, **ClassLib** minimizes dependencies on the game, ensuring optimal compatibility. The library is crafted to seamlessly integrate into nanos world's scripting environment.
* #### **Portability**
  * While **ClassLib** is tailored for nanos world, it boasts a high degree of portability. With 95% of the library written in pure Lua, it can be easily adapted to other projects and platforms as needed.

***

## Credits

The inception of ClassLib owes credit to [MegaThorx ](https://github.com/MegaThorx)and their EGUI package, serving as the foundational inspiration.

Special thanks go to [Mouloud](https://github.com/MouloudP) and [Aerox](https://github.com/aeroxfr) for their invaluable contributions in testing and providing feedback during the early stages of the library. Their input has played a crucial role in refining and enhancing the library.