From 2cedf6ffd7ed639ce6c9dd78456caa4167e8055d Mon Sep 17 00:00:00 2001 From: iThorgrim <125808072+iThorgrim@users.noreply.github.com> Date: Sun, 9 Nov 2025 15:34:33 +0100 Subject: [PATCH] Chore: Rename Eluna to ALE (#344) --- docs/IMPL_DETAILS.md | 8 +++--- docs/INSTALL.md | 26 ++++++------------ docs/USAGE.md | 4 +-- .../docs/{ElunaDoc => ALEDoc}/.gitignore | 0 .../docs/{ElunaDoc => ALEDoc}/__init__.py | 0 .../docs/{ElunaDoc => ALEDoc}/__main__.py | 16 +++++------ .../docs/{ElunaDoc => ALEDoc}/parser.py | 4 +-- .../static/FiraSans-Medium.woff | Bin .../static/FiraSans-Regular.woff | Bin .../static/Heuristica-Italic.woff | Bin .../static/SourceCodePro-Regular.woff | Bin .../static/SourceCodePro-Semibold.woff | Bin .../static/SourceSerifPro-Bold.woff | Bin .../static/SourceSerifPro-Regular.woff | Bin .../docs/{ElunaDoc => ALEDoc}/static/dark.css | 0 .../static/eluna-logo.png | Bin .../{ElunaDoc => ALEDoc}/static/favicon.ico | Bin .../{ElunaDoc => ALEDoc}/static/jquery.js | 0 .../docs/{ElunaDoc => ALEDoc}/static/main.css | 0 .../docs/{ElunaDoc => ALEDoc}/static/main.js | 2 +- .../{ElunaDoc => ALEDoc}/static/normalize.css | 0 .../{ElunaDoc => ALEDoc}/templates/_base.html | 10 +++---- .../{ElunaDoc => ALEDoc}/templates/class.html | 2 +- .../{ElunaDoc => ALEDoc}/templates/date.js | 0 .../{ElunaDoc => ALEDoc}/templates/enum.html | 0 .../{ElunaDoc => ALEDoc}/templates/index.html | 26 +++++++++--------- .../templates/method.html | 6 ++-- .../templates/search-index.js | 0 .../{ElunaDoc => ALEDoc}/templates/sidebar.js | 0 29 files changed, 48 insertions(+), 56 deletions(-) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/.gitignore (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/__init__.py (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/__main__.py (91%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/parser.py (99%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/FiraSans-Medium.woff (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/FiraSans-Regular.woff (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/Heuristica-Italic.woff (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/SourceCodePro-Regular.woff (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/SourceCodePro-Semibold.woff (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/SourceSerifPro-Bold.woff (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/SourceSerifPro-Regular.woff (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/dark.css (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/eluna-logo.png (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/favicon.ico (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/jquery.js (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/main.css (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/main.js (99%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/static/normalize.css (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/templates/_base.html (90%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/templates/class.html (98%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/templates/date.js (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/templates/enum.html (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/templates/index.html (75%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/templates/method.html (93%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/templates/search-index.js (100%) rename src/LuaEngine/docs/{ElunaDoc => ALEDoc}/templates/sidebar.js (100%) diff --git a/docs/IMPL_DETAILS.md b/docs/IMPL_DETAILS.md index 80c5e8d..7c9dd02 100644 --- a/docs/IMPL_DETAILS.md +++ b/docs/IMPL_DETAILS.md @@ -45,7 +45,7 @@ ALE settings are located in the AzerothCore server configuration file. Reload scripts during development with: ``` -.reload eluna +.reload ale ``` > [!CAUTION] @@ -160,7 +160,7 @@ end #### Safe to Store These userdata objects are Lua-managed and safe to store: -- Query results (`ElunaQuery`) +- Query results (`ALEQuery`) - World packets (`WorldPacket`) - 64-bit numbers (`uint64`, `int64`) @@ -384,7 +384,7 @@ Check these locations for errors: Enable traceback in the server config for detailed error information: ``` -Eluna.TraceBack = 1 +ALE.TraceBack = 1 ``` This adds call stack information to errors. @@ -394,7 +394,7 @@ This adds call stack information to errors. 1. **Start Small**: Test basic functionality first 2. **Add Gradually**: Implement features one at a time 3. **Test Each Step**: Verify each addition works before moving on -4. **Use Reload**: Use `.reload eluna` for quick iteration (dev only) +4. **Use Reload**: Use `.reload ale` for quick iteration (dev only) 5. **Full Restart**: Always do final testing with a server restart ### Common Issues diff --git a/docs/INSTALL.md b/docs/INSTALL.md index c28dba3..80fa23a 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -127,23 +127,23 @@ cmake --build . --config Release The compilation process generates updated config files with ALE settings. Without these, ALE may not function correctly (no error messages, logging issues, etc.). **Location of config files:** -- Usually in your server's `etc/` or `configs/` directory -- Look for files like `worldserver.conf` +- Usually in your server's `etc/modules` or `configs/modules` directory +- Look for files like `mod-ale.conf` Copy the new `.conf.dist` files: ```bash # Example - adjust paths as needed -cp worldserver.conf.dist worldserver.conf +cp mod-ale.conf.dist mod-ale.conf ``` Then edit `worldserver.conf` and configure ALE settings (see [Configuration](#-configuration) below). ## ⚙️ Configuration -### ALE Settings in worldserver.conf +### ALE Settings in mod-ale.conf -After installation, configure ALE by editing your `worldserver.conf` file: +After installation, configure ALE by editing your `mod-ale.conf` file: ```ini ################################################################################################### @@ -152,24 +152,16 @@ After installation, configure ALE by editing your `worldserver.conf` file: # Enable or disable ALE # Default: 1 (enabled) -Eluna.Enabled = 1 +ALE.Enabled = 1 # Enable traceback for detailed error information # Useful for debugging but has performance overhead # Default: 1 (enabled) -Eluna.TraceBack = 1 +ALE.TraceBack = 1 # Script folder location (relative to server binary) # Default: "lua_scripts" -Eluna.ScriptPath = "lua_scripts" - -# Logging level -# 0 = Disabled -# 1 = Errors only -# 2 = Errors and warnings -# 3 = All messages (debug) -# Default: 2 -Eluna.LogLevel = 2 +ALE.ScriptPath = "lua_scripts" ``` ### Creating the Scripts Folder @@ -234,7 +226,7 @@ cmake --build . --config Release **Check these things:** 1. **Config file**: Ensure you're using the new `worldserver.conf` generated after compilation -2. **Enabled setting**: Verify `Eluna.Enabled = 1` in config +2. **Enabled setting**: Verify `ALE.Enabled = 1` in config 3. **Script path**: Ensure `lua_scripts` folder exists in the correct location 4. **Logs**: Check server logs for error messages diff --git a/docs/USAGE.md b/docs/USAGE.md index 7c3083e..8232bfd 100644 --- a/docs/USAGE.md +++ b/docs/USAGE.md @@ -236,11 +236,11 @@ end For quick testing during development, you can reload scripts without restarting: ``` -.reload eluna +.reload ale ``` > [!WARNING] -> **Development Only:** Use `.reload eluna` only for development. For production or if experiencing issues, always restart the server. +> **Development Only:** Use `.reload ale` only for development. For production or if experiencing issues, always restart the server. **Important Limitations:** - Reloading doesn't trigger events like login for already-connected players diff --git a/src/LuaEngine/docs/ElunaDoc/.gitignore b/src/LuaEngine/docs/ALEDoc/.gitignore similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/.gitignore rename to src/LuaEngine/docs/ALEDoc/.gitignore diff --git a/src/LuaEngine/docs/ElunaDoc/__init__.py b/src/LuaEngine/docs/ALEDoc/__init__.py similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/__init__.py rename to src/LuaEngine/docs/ALEDoc/__init__.py diff --git a/src/LuaEngine/docs/ElunaDoc/__main__.py b/src/LuaEngine/docs/ALEDoc/__main__.py similarity index 91% rename from src/LuaEngine/docs/ElunaDoc/__main__.py rename to src/LuaEngine/docs/ALEDoc/__main__.py index d8bf99f..2d54bd0 100644 --- a/src/LuaEngine/docs/ElunaDoc/__main__.py +++ b/src/LuaEngine/docs/ALEDoc/__main__.py @@ -3,7 +3,7 @@ import shutil import typing from jinja2 import Environment, FileSystemLoader from typedecorator import params, returns -from ElunaDoc.parser import ClassParser, MethodDoc +from ALEDoc.parser import ClassParser, MethodDoc import glob import time @@ -11,10 +11,10 @@ import time @returns([(str, typing.IO)]) @params(search_path=str) def find_class_files(search_path): - """Find and open all files containing Eluna class methods in `search_path`. + """Find and open all files containing ALE class methods in `search_path`. - :param search_path: the path to search for Eluna methods in - :return: a list of all files containing Eluna methods, and the name of their respective classes + :param search_path: the path to search for ALE methods in + :return: a list of all files containing ALE methods, and the name of their respective classes """ # Search for all files ending in "Methods.h". method_file_names = glob.glob(os.path.join(search_path, '**', '*Methods.h')) @@ -55,10 +55,10 @@ if __name__ == '__main__': if os.path.exists('build'): shutil.rmtree('build') os.mkdir('build') - shutil.copytree('ElunaDoc/static', 'build/static') + shutil.copytree('ALEDoc/static', 'build/static') # Load up all files with methods we need to parse. - print('Finding Eluna method files...') + print('Finding ALE method files...') class_files = find_class_files('../') # Parse all the method files. @@ -131,7 +131,7 @@ if __name__ == '__main__': # Case for enums to direct to a search on github enum_name = content[1:-1] - url = 'https://github.com/ElunaLuaEngine/ElunaTrinityWotlk/search?l=cpp&q=%22enum+{}%22&type=Code&utf8=%E2%9C%93'.format(enum_name) + url = 'https://github.com/azerothcore/azerothcore-wotlk/search?l=cpp&q=%22enum+{}%22&type=Code&utf8=%E2%9C%93'.format(enum_name) return '{}'.format(url, enum_name) # By default we just return the name without the [] around it @@ -140,7 +140,7 @@ if __name__ == '__main__': return link_parser, data_type_parser # Create the render function with the template path and parser maker. - render = make_renderer('ElunaDoc/templates', make_parsers) + render = make_renderer('ALEDoc/templates', make_parsers) # Render the index. render('index.html', 'index.html', level=0, classes=classes) diff --git a/src/LuaEngine/docs/ElunaDoc/parser.py b/src/LuaEngine/docs/ALEDoc/parser.py similarity index 99% rename from src/LuaEngine/docs/ElunaDoc/parser.py rename to src/LuaEngine/docs/ALEDoc/parser.py index 0a0f115..b03c642 100644 --- a/src/LuaEngine/docs/ElunaDoc/parser.py +++ b/src/LuaEngine/docs/ALEDoc/parser.py @@ -6,7 +6,7 @@ from typedecorator import params, returns, Nullable class ParameterDoc(object): - """The documentation data of a parameter or return value for an Eluna method.""" + """The documentation data of a parameter or return value for an ALE method.""" # The integer ranges that each C++ type is valid for. None means valid for all numbers. valid_ranges = { @@ -64,7 +64,7 @@ class ParameterDoc(object): class MethodDoc(object): - """The documentation data of an Eluna method.""" + """The documentation data of an ALE method.""" @params(self=object, name=str, description=str, prototypes=[str], parameters=[ParameterDoc], returned=[ParameterDoc]) def __init__(self, name, description, prototypes, parameters, returned): self.name = name diff --git a/src/LuaEngine/docs/ElunaDoc/static/FiraSans-Medium.woff b/src/LuaEngine/docs/ALEDoc/static/FiraSans-Medium.woff similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/static/FiraSans-Medium.woff rename to src/LuaEngine/docs/ALEDoc/static/FiraSans-Medium.woff diff --git a/src/LuaEngine/docs/ElunaDoc/static/FiraSans-Regular.woff b/src/LuaEngine/docs/ALEDoc/static/FiraSans-Regular.woff similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/static/FiraSans-Regular.woff rename to src/LuaEngine/docs/ALEDoc/static/FiraSans-Regular.woff diff --git a/src/LuaEngine/docs/ElunaDoc/static/Heuristica-Italic.woff b/src/LuaEngine/docs/ALEDoc/static/Heuristica-Italic.woff similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/static/Heuristica-Italic.woff rename to src/LuaEngine/docs/ALEDoc/static/Heuristica-Italic.woff diff --git a/src/LuaEngine/docs/ElunaDoc/static/SourceCodePro-Regular.woff b/src/LuaEngine/docs/ALEDoc/static/SourceCodePro-Regular.woff similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/static/SourceCodePro-Regular.woff rename to src/LuaEngine/docs/ALEDoc/static/SourceCodePro-Regular.woff diff --git a/src/LuaEngine/docs/ElunaDoc/static/SourceCodePro-Semibold.woff b/src/LuaEngine/docs/ALEDoc/static/SourceCodePro-Semibold.woff similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/static/SourceCodePro-Semibold.woff rename to src/LuaEngine/docs/ALEDoc/static/SourceCodePro-Semibold.woff diff --git a/src/LuaEngine/docs/ElunaDoc/static/SourceSerifPro-Bold.woff b/src/LuaEngine/docs/ALEDoc/static/SourceSerifPro-Bold.woff similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/static/SourceSerifPro-Bold.woff rename to src/LuaEngine/docs/ALEDoc/static/SourceSerifPro-Bold.woff diff --git a/src/LuaEngine/docs/ElunaDoc/static/SourceSerifPro-Regular.woff b/src/LuaEngine/docs/ALEDoc/static/SourceSerifPro-Regular.woff similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/static/SourceSerifPro-Regular.woff rename to src/LuaEngine/docs/ALEDoc/static/SourceSerifPro-Regular.woff diff --git a/src/LuaEngine/docs/ElunaDoc/static/dark.css b/src/LuaEngine/docs/ALEDoc/static/dark.css similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/static/dark.css rename to src/LuaEngine/docs/ALEDoc/static/dark.css diff --git a/src/LuaEngine/docs/ElunaDoc/static/eluna-logo.png b/src/LuaEngine/docs/ALEDoc/static/eluna-logo.png similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/static/eluna-logo.png rename to src/LuaEngine/docs/ALEDoc/static/eluna-logo.png diff --git a/src/LuaEngine/docs/ElunaDoc/static/favicon.ico b/src/LuaEngine/docs/ALEDoc/static/favicon.ico similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/static/favicon.ico rename to src/LuaEngine/docs/ALEDoc/static/favicon.ico diff --git a/src/LuaEngine/docs/ElunaDoc/static/jquery.js b/src/LuaEngine/docs/ALEDoc/static/jquery.js similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/static/jquery.js rename to src/LuaEngine/docs/ALEDoc/static/jquery.js diff --git a/src/LuaEngine/docs/ElunaDoc/static/main.css b/src/LuaEngine/docs/ALEDoc/static/main.css similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/static/main.css rename to src/LuaEngine/docs/ALEDoc/static/main.css diff --git a/src/LuaEngine/docs/ElunaDoc/static/main.js b/src/LuaEngine/docs/ALEDoc/static/main.js similarity index 99% rename from src/LuaEngine/docs/ElunaDoc/static/main.js rename to src/LuaEngine/docs/ALEDoc/static/main.js index cb3f4bf..80c39fc 100644 --- a/src/LuaEngine/docs/ElunaDoc/static/main.js +++ b/src/LuaEngine/docs/ALEDoc/static/main.js @@ -497,7 +497,7 @@ ''; }); } else { - output += 'No results - Request function at Eluna issue tracker'; + output += 'No results - Request function at ALE issue tracker'; } output += "

"; diff --git a/src/LuaEngine/docs/ElunaDoc/static/normalize.css b/src/LuaEngine/docs/ALEDoc/static/normalize.css similarity index 100% rename from src/LuaEngine/docs/ElunaDoc/static/normalize.css rename to src/LuaEngine/docs/ALEDoc/static/normalize.css diff --git a/src/LuaEngine/docs/ElunaDoc/templates/_base.html b/src/LuaEngine/docs/ALEDoc/templates/_base.html similarity index 90% rename from src/LuaEngine/docs/ElunaDoc/templates/_base.html rename to src/LuaEngine/docs/ALEDoc/templates/_base.html index c5f2d8b..50cce3f 100644 --- a/src/LuaEngine/docs/ElunaDoc/templates/_base.html +++ b/src/LuaEngine/docs/ALEDoc/templates/_base.html @@ -3,10 +3,10 @@ - - + + - {% block title %}Eluna API{% endblock %} + {% block title %}ALE API{% endblock %} @@ -23,7 +23,7 @@