Skip to content

azerothcore/mod-eluna

 
 

Repository files navigation

mod-eluna

Unleash the power of Lua scripting in your AzerothCore server

Discord Lua AzerothCore


Important

mod-eluna is an independent Lua scripting engine specifically designed for AzerothCore. This project has diverged from the original Eluna project and is no longer compatible with standard Eluna scripts. Scripts written for mod-eluna will not work with the original Eluna engine and vice versa.

🚀 Overview

mod-eluna is a powerful, AzerothCore-specific implementation of a Lua scripting engine that enables server administrators and developers to create custom gameplay features, events, and mechanics without modifying the core server code.

Key Features

  • Native AzerothCore Integration: Built specifically for AzerothCore's architecture
  • Enhanced API: Extended functionality for AzerothCore, beyond the original Eluna specification.
  • Community-Driven Development: Actively maintained with community contributions

⚠️ Compatibility Notice

mod-eluna vs Original Eluna

mod-eluna is NOT compatible with the original Eluna project. This fork has evolved independently with AzerothCore-specific enhancements and API changes that make scripts non-interchangeable.

For Original Eluna Compatibility

If you need to use standard Eluna scripts or maintain compatibility with the original Eluna project, please use the dedicated AzerothCore port available at:

🔗 ElunaAzerothCore

This repository maintains compatibility with the original Eluna API and supports standard Eluna scripts.

📋 Table of Contents

⚡ Installation

Prerequisites

  • AzerothCore server installation
  • Git version control system
  • CMake build system

Installation Steps

# Navigate to your AzerothCore modules directory
cd <azerothcore-path>/modules

# Clone the mod-eluna repository
git clone https://github.com/azerothcore/mod-eluna.git

# Configure build with your preferred Lua version
cd <azerothcore-build-directory>
cmake ../ -DLUA_VERSION=luajit  # Options: luajit, lua52, lua53, lua54

# Default: If no version is specified, Lua 5.2 will be used

# Rebuild your AzerothCore server
make -j$(nproc)

Supported Lua Versions

  • LuaJIT (Recommended for performance)
  • Lua 5.2 (Default)
  • Lua 5.3
  • Lua 5.4

📚 Documentation

Getting Started

API Reference

Warning

API Differences: mod-eluna functions may not be available in the original Eluna project and vice versa. Always refer to the mod-eluna specific documentation when developing scripts.

💬 Support

Getting Help

Resources

🤝 Contributing

We welcome contributions from the community! Here's how you can help:

Development Workflow

graph LR
    A[Fork Repository] --> B[Create Branch]
    B --> C[Make Changes]
    C --> D[Submit PR]
    D --> E[Review Process]
Loading

Contribution Guidelines

  1. Fork the repository
  2. Create a feature branch from master
  3. Implement your changes with proper testing
  4. Follow the existing code style and conventions
  5. Submit a pull request with a clear description

🌟 Acknowledgements

Original Project

mod-eluna is built upon the foundation of the original Eluna project. We acknowledge and thank the original Eluna team for their pioneering work in Lua scripting for World of Warcraft server emulators.

Related Projects

Supported Emulators

📄 License

This project is licensed under the GNU General Public License v3.0. See LICENSE for details.


Developed with ❤️ by the AzerothCore and mod-eluna community

⬆ Back to Top

Releases

No releases published

Packages

No packages published

Languages

  • C++ 93.1%
  • JavaScript 2.1%
  • Python 1.4%
  • CSS 1.3%
  • CMake 1.0%
  • HTML 0.8%
  • C 0.3%