Luagin

KO | EN

gitlite — search

#typescript #ai-agents #ai #dsh-plugin #deepseek-harness #open-source #cli #claude-code #codex #developer-tools #react #windows

★ 33 Open GitHub ↗

Luagin is a plugin based on the bukkit API and LuaJIT. It allows developers to highly customize the server through Lua scripts in an extremely effective and efficient manner.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

📑 <a href="#-overview">Overview</a> • <a href="#-documents">Documents</a> • <a href="#%EF%B8%8F-configs">Configs</a> • <a href="#-web-panel">Web Panel</a> • <a href="#-compatibility">Compatibility</a> • <a href="#%EF%B8%8F-support">Support</a> • <a href="#%EF%B8%8F-license">License</a>

🌐 <a href="./README.md">English</a> | <a href="./README_zh.md">中文</a>

---

## 📖 Overview

**Luagin** is a plugin based on the **Bukkit API** and **LuaJIT**. It allows developers to highly customize
the server through Lua scripts in an extremely effective and efficient manner.

### 🚀 Features

| Features                             | Advantages                                                                                                                |
|--------------------------------------|---------------------------------------------------------------------------------------------------------------------------|
| LuaJIT Implementation                | Extremely high running speed, complete support for Lua features.                                                          |
| Friendly API design                  | Highly abstract and encapsulated, fluent chainable calls, excellent readability. More convenient Java object interaction. |
| Friendly API docs                    | Easy to read, professional API docs.                                                                                      |
| Inter-script communication           | Be competent for large and complex plugin development, even more modular.                                                 |
| Translation                          | Language configs in different countries or regions that can be contributed by the community.                              |
| Web Panel                            | Modern Web panel can help you monitor server data and configure plugin intuitively and conveniently.                      |

### ❓ Why Lua/Luagin

1. **Easy to learn**: Lua is a **lightweight, simple yet powerful** scripting language. Even beginners can quickly get
   started with it.
2. **Efficient**: With Luagin, you **don't need** to build and manage **complex projects**, write **extensive
   boilerplate code**, or navigate through **hard-to-read APIs**, like you would when developing Java plugins.
3. **Hot update**: **Reloading** scripts takes effect immediately, greatly improving the development experience and
   reducing the cost of trial and error.
4. **Security**: Lua scripts run in a **controlled environment**, making it highly unlikely for them to crash the server
   or cause other serious issues.
5. **Abstraction and Encapsulation**: By **highly abstracting and encapsulating** on the Java side, calling APIs on the
   Lua side can greatly **reduce development difficulty and time**.
6. **Extension**: **Highly abstract and encapsulated** does not mean that developers can only implement functions
   according to Luagin's wishes. On the contrary, it can call **all original server APIs** and **has more extensions**.

## 📚 Documents

https://ezeny.gitbook.io/luagin-docs

Due to insufficient time, the document currently only contains necessary
    information, which means you need to search for relevant information about
    some classes and their methods in Bukkit's documentation.

## ⚙️ Configs

Configuration location - `plugins/Luagin/configs`

Language config location - `plugins/Luagin/lang`

## 🌀 Web Panel

If you enable the web panel in the configuration file, access the panel through `localhost:9527`. Chinese and English are supported.

The default username and password are "admin".

## 🧪 Compatibility

- The supported game versions depend on the **server-side API**.
- The support for `Bukkit` and its branches depends on the compatibility between the `Spigot` API and them. (**currently
  almost compatible**)

### 📦 Dependencies

- **Required**: None - Luagin works standalone
- **Optional**: [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/) - Required only if you want to use the `protocol` API to monitor, modify or cancel network packets

## 🛠️ Support

If you want to report bugs or suggest new features, you
can [open an issue on Github](https://github.com/Ezeny1337/Luagin/issues).

If you need help using Luagin, please contact me on Discord: **ez3nyck**

## ⚖️ License

Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

Luagin

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README