diff --git a/README.md b/README.md index dbb23e4..8bc3dd9 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,26 @@ +### [![Eluna](src/LuaEngine/docs/Eluna.png)](https://github.com/ElunaLuaEngine/Eluna) + +## About + +Eluna Lua Engine © is a lua engine embedded to World of Warcraft emulators. Eluna supports MaNGOS, CMaNGOS, TrinityCore and AzerothCore. +We are currently working hard to make Eluna better from inside and outside. + +If you are having trouble with installation or scripts, please feel free to open an issue. +For documentation and reference see [Eluna API (AC version)](https://www.azerothcore.org/pages/eluna/index.html) and [Lua reference manual](http://www.lua.org/manual/5.2/). + + +## Community + +You can join the official Eluna Discord server, where you'll be able to find resources, releases and support provided by the community: + + + + +The official Azerothcore Discord server offers a channel dedicated to lua development as well: + + + + # ![logo](https://raw.githubusercontent.com/azerothcore/azerothcore.github.io/master/images/logo-github.png) mod-eluna-lua-engine for AzerothCore - Latest build status with azerothcore: [![Build Status](https://github.com/azerothcore/mod-eluna-lua-engine/workflows/core-build/badge.svg?branch=master&event=push)](https://github.com/azerothcore/mod-eluna-lua-engine) @@ -5,6 +28,7 @@ An [Eluna](https://github.com/ElunaLuaEngine/Eluna) module for AzerothCore. + ## How to install: ### 1) Download the sources @@ -17,13 +41,8 @@ You can get the sources using git. 2. go inside the **modules** folder: `cd modules` 3. download the module sources using: ``` -git clone https://github.com/azerothcore/mod-eluna-lua-engine.git +git clone https://github.com/azerothcore/Eluna.git ``` -4. go inside the **mod-eluna-lua-engine** folder: `cd mod-eluna-lua-engine` -5. download the Eluna sources using `git submodule update --init` - -Optional: if you need to update Eluna to the latest version, you can `cd src` and `cd LuaEngine` and run `git pull` from there. - ### 2) Build @@ -32,6 +51,37 @@ You need to run the cmake again and and rebuild the project. Eluna API for AC: [https://www.azerothcore.org/pages/eluna/index.html](https://www.azerothcore.org/pages/eluna/index.html) + +## Documentation + +* [Getting started](https://github.com/ElunaLuaEngine/Eluna/blob/master/docs/USAGE.md) +* [Eluna features](https://github.com/ElunaLuaEngine/Eluna/blob/master/docs/IMPL_DETAILS.md) +* [Function documentation (AC version)](https://www.azerothcore.org/pages/eluna/index.html) +* [Hook documentation](https://github.com/ElunaLuaEngine/Eluna/blob/master/Hooks.h) +* [Lua reference manual](http://www.lua.org/manual/5.2/) +* [Forum - support, releases, guides](https://www.getmangos.eu/forums/forum/119-eluna-central/) +* [Example scripts](https://github.com/ElunaLuaEngine/Scripts) +* [Contributing](https://github.com/ElunaLuaEngine/Eluna/blob/master/docs/CONTRIBUTING.md) + + +## Links + +* [MaNGOS](http://getmangos.eu/) +* [cMaNGOS](http://cmangos.net/) +* [TrinityCore](http://www.trinitycore.org/) +* [AzerothCore](http://www.azerothcore.org/) +* [Lua.org](http://www.lua.org/) +* [License](https://github.com/ElunaLuaEngine/Eluna/blob/master/docs/LICENSE.md) + + +## Additions from Eluna/master + +- Added HttpRequest method. https://github.com/azerothcore/Eluna/pull/2 +- Added RegisterPlayerEvent 43: `OnBeforePetAddedToWorld()` fires for pets and summoned creatures. https://github.com/azerothcore/Eluna/pull/3 +- Added Chat-Handler methods to player events. https://github.com/azerothcore/Eluna/pull/23 +- Exposed `ModifyThreatPct()`. https://github.com/azerothcore/Eluna/pull/25 + + ## How to update the Eluna version (for project mainteners) 1) `cd` into `mod-eluna-lua-engine`