EQ2Emu/server/server_readme.md

📦 EQ2Emu Server Directory Layout

This document describes the structure and purpose of the EQ2Emu server directory.

📚 Table of Contents

• Overview
• Network Structure XML Files
• Script Folders
• Data Folders
• Definition Files
• Executables
• Example Configuration Files
• Notes

---

Overview

/ (base directory)
├── *.xml (Network Structure Files)
├── ItemScripts/
├── Quests/
├── RegionScripts/
├── SpawnScripts/
├── Spells/
├── ZoneScripts/
├── Maps/
├── Regions/
├── logs/
├── log_config.xml
├── login_db.ini
├── world_db.ini
├── server_config.json
├── login (executable)
└── eq2world (executable)

---

📡 Network Structure XML Files

These XML files define the client-server network structures used by EQ2Emu:

• CommonStructs.xml
• EQ2_Structs.xml
• ItemStructs.xml
• LoginStructs.xml
• SpawnStructs.xml
• WorldStructs.xml

---

🧹 Script Folders

Custom server-side Lua scripts that drive server content:

• ItemScripts/: Item-specific scripts.
• Quests/: Quest-related scripts.
• RegionScripts/: Regional behavior.
• SpawnScripts/: NPC spawning behavior.
• Spells/: Spell logic.
• ZoneScripts/: Zone triggers and scripting.

---

📂 Data Folders

Stores important data and logs:

• Maps/: Zone layout and navigation meshes.
• Regions/: Zone regional metadata.
• logs/: Runtime logs for diagnostics.

---

⚙️ Definition Files

Configuration files necessary to operate the server:

• log_config.xml: Logging configuration.
• login_db.ini: Login server database connection.
• world_db.ini: World server database connection.
• server_config.json: Main configuration for login/world server and ports.

---

🚀 Executables

login

• Handles login from EverQuest II clients.
• Clients use cl_ls_address in eq2_default.ini to connect.
• Default UDP Port: 9100.
• Configured via LoginConfig -> ServerPort in server_config.json.

eq2world

• Acts as the world and zone server.
• Connects to login via TCP on 9100 (default).
• Manages character creation, server list, and zoning.
• Default UDP port: 9001 (can be customized via LoginServer -> worldport in server_config.json).

---

📑 Example Configuration Files

These examples are included for quick setup:

• log_config.xml.example
• login_db.ini.example
• world_db.ini.example
• server_config.json.example

---

📌 Notes

• All ports can be customized via server_config.json.
• Lua script folders are modular and extensible.
• Example config files are included to assist with initial setup.