From 0bbdb58679565e025516e4f7d4d3a95600822b74 Mon Sep 17 00:00:00 2001 From: Chris Miles Date: Thu, 15 May 2025 15:26:07 -0500 Subject: [PATCH] Update README.md --- README.md | 179 +++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 124 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 59e525af6..32a85b339 100644 --- a/README.md +++ b/README.md @@ -1,79 +1,148 @@ -# EQEmulator Core Server -| Drone (Linux x64) | Drone (Windows x64) | -|:---:|:---:| -|[![Build Status](http://drone.akkadius.com/api/badges/EQEmu/Server/status.svg)](http://drone.akkadius.com/EQEmu/Server) |[![Build Status](http://drone.akkadius.com/api/badges/EQEmu/Server/status.svg)](http://drone.akkadius.com/EQEmu/Server) | +

EQEmulator Server Platform

+ +

+ +

+ +

+EverQuest Emulator (EQEmu) - A Fan-Made Project Honoring the Legendary MMORPG +

+ +

+Contributors +Discord +Docs +License +Latest Release +Release Date +Github All Releases +Build Status +GitHub Issues or Pull Requests +Docker Pulls +Build Status Official + +

*** -**EQEmulator is a custom completely from-scratch open source server implementation for EverQuest built mostly on C++** - * MySQL/MariaDB is used as the database engine (over 200+ tables) - * Perl and LUA are both supported scripting languages for NPC/Player/Quest oriented events - * Open source database (Project EQ) has content up to expansion OoW (included in server installs) - * Game server environments and databases can be heavily customized to create all new experiences - * Hundreds of Quests/events created and maintained by Project EQ +

+EQEmulator is a passion-driven, open source server emulator project dedicated to preserving and celebrating the groundbreaking world of EverQuest, the massively multiplayer online role-playing game originally developed by Verant Interactive and Sony Online Entertainment (now Daybreak Game Company). +

-## Server Installs -| |Windows|Linux| -|:---:|:---:|:---:| -|**Install Count**|![Windows Install Count](http://analytics.akkadius.com/?install_count&windows_count)|![Linux Install Count](http://analytics.akkadius.com/?install_count&linux_count)| -### > Windows +

+For over two decades and continuing, EQEmulator has served as a fan tribute, providing tools and technology that allow players to explore, customize, and experience EverQuest’s iconic gameplay in new ways. This project exists solely out of deep admiration for the original developers, artists, designers, and visionaries who created one of the most influential online worlds of all time. +

-* [Install Guide](https://docs.eqemu.io/server/installation/server-installation-windows/) +

+We do not claim ownership of EverQuest or its assets. All credit and respect belong to the original creators and Daybreak Game Company, whose work continues to inspire generations of players and developers alike. +

-### > Debian/Ubuntu/CentOS/Fedora +

+EQEmulator has for over 20 years and always will be a fan-based, non-commercial open-source effort made by players, for players—preserving the legacy of EverQuest while empowering community-driven creativity, learning and joy that the game and its creators has so strongly inspired in us all. +

-* [Install Guide](https://docs.eqemu.io/server/installation/server-installation-linux/) +*** -* You can use curl or wget to kick off the installer (whichever your OS has) -> curl -O https://raw.githubusercontent.com/EQEmu/Server/master/utils/scripts/linux_installer/install.sh install.sh && chmod 755 install.sh && ./install.sh +

+ Technical Overview & Reverse Engineering Effort +

-> wget --no-check-certificate https://raw.githubusercontent.com/EQEmu/Server/master/utils/scripts/linux_installer/install.sh -O install.sh && chmod 755 install.sh && ./install.sh +

EQEmulator represents over two decades of collaborative reverse engineering, rebuilding the EverQuest server from the ground up without access to the original source code. This effort was achieved entirely through community-driven analysis, network protocol decoding, and in-game behavioral research.

-## Supported Clients +

+ 💡 How We Did It +

+ + +

+ +

+ + +

+ Reverse Engineering +Every system, packet, opcode, and game mechanic has been reconstructed through countless hours of live packet sniffing, client disassembly, and in-game experimentation by dedicated contributors over the years. +

+ +

+ No proprietary code or server sources were ever used. +

+ +

+ All implementations are the result of clean-room engineering. +

+ + +

+ 🛠️ Technology Stack +

+ +

+ +

+ +**C++ Core Engine** + +* High-performance networking and gameplay logic built in C++ +* Cross-platform support for Linux and Windows + +**MySQL / MariaDB Backend** + +* Fully structured schema with over 200+ tables +* Supports content customization, expansions, and custom worlds + +**Scripting Engine** + +* Native support for **Perl** and **Lua** scripting +* Powerfully extendable for quests, NPC behaviors, and custom events + +**Open Source Content Database** + +* Includes ProjectEQ’s world data up through *Dragons of Norrath* +* 100% customizable to create entirely new game worlds + +

+ 🚀 Why It Matters +

+ +

🧬 EQEmulator stands as a technical preservation project, ensuring that the magic of classic and custom EverQuest servers lives on for future generations of players, tinkerers, and game designers. +

+ +> We humbly acknowledge and thank the original developers at **Verant Interactive** and **Sony Online Entertainment (now Daybreak Game Company)** for creating one of the most influential online experiences in gaming history. + +

+ 🧑‍💻🖥️ Supported Clients +

|Titanium Edition|Secrets of Faydwer|Seeds of Destruction|Underfoot|Rain of Fear| |:---:|:---:|:---:|:---:|:---:| |||||| -## Bug Reports -* Please use the [issue tracker](https://github.com/EQEmu/Server/issues) provided by GitHub to send us bug -reports or feature requests. -* The [EQEmu Forums](http://www.eqemulator.org/forums/) are also a place to submit and get help with bugs. +## 📚 Resources -## Contributions +| Resource | Badges | Link | +|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------| +| **EQEmulator Docs** | [![Docs](https://img.shields.io/badge/docs-MkDocs%20Powered-blueviolet)](https://docs.eqemu.io) | [docs.eqemu.io](https://docs.eqemu.io/) | +| **Discord Community**| [![Discord](https://img.shields.io/discord/212663220849213441?label=Discord&logo=discord&color=7289DA)](https://discord.gg/QHsm7CD) | [Join Discord](https://discord.gg/QHsm7CD) | +| **Latest Release** | [![Latest Release](https://img.shields.io/github/v/release/eqemu/server)](https://github.com/eqemu/server/releases)
[![Release Date](https://img.shields.io/github/release-date/EQEmu/Server)](https://github.com/EQEmu/Server/releases)
[![All Releases](https://img.shields.io/github/downloads/eqemu/server/total.svg)](https://github.com/eqemu/server/releases) | [View Releases](https://github.com/eqemu/server/releases) | +| **License** | [![License](https://img.shields.io/github/license/EQEmu/Server)](./LICENSE) | [View License](./LICENSE) | +| **Build Status** | [![Build Status](http://drone.akkadius.com/api/badges/EQEmu/Server/status.svg)](http://drone.akkadius.com/EQEmu/Server) | [View Build Status](http://drone.akkadius.com/EQEmu/Server) | +| **Docker Pulls** | [![Docker Pulls](https://img.shields.io/docker/pulls/akkadius/eqemu-server)](https://hub.docker.com/r/akkadius/eqemu-server) | [Docker Hub](https://hub.docker.com/r/akkadius/eqemu-server) | +| **Contributions** | [![GitHub PRs](https://img.shields.io/github/issues-pr-closed/eqemu/server)](https://github.com/eqemu/server/pulls?q=is%3Apr+is%3Aclosed) | [Closed PRs & Issues](https://github.com/eqemu/server/pulls?q=is%3Apr+is%3Aclosed) | -* The preferred way to contribute is to fork the repo and submit a pull request on -GitHub. If you need help with your changes, you can always post on the forums or -try Discord. You can also post unified diffs (`git diff` should do the trick) on the -[Server Code Submissions](http://www.eqemulator.org/forums/forumdisplay.php?f=669) -forum, although pull requests will be much quicker and easier on all parties. +## 🛠️ Getting Started -## Contact +If you want to set up your own EQEmulator server, please refer to the current [server installation guides](https://docs.eqemu.io/#server-installation). We've had 100,000s of players and developers use our guides to set up their own servers, and we hope you will too! - - Discord Channel: https://discord.gg/QHsm7CD - - **User Discord Channel**: `#general` - - **Developer Discord Channel**: `#eqemucoders` +## 🗂️ Related Repositories -## Resources -- [EQEmulator Forums](http://www.eqemulator.org/forums) -- [EQEmulator Wiki](https://docs.eqemu.io/) +| Repository | Description | +|--------------------|----------------------------------------------------------------------------------| +| [ProjectEQ Quests](https://github.com/ProjectEQ/projecteqquests) | Official quests and event scripts for ProjectEQ | +| [Maps](https://github.com/Akkadius/EQEmuMaps) | EQEmu-compatible zone maps | +| [Installer Resources](https://github.com/Akkadius/EQEmuInstall) | Scripts and assets for setting up EQEmu servers | +| [Zone Utilities](https://github.com/EQEmu/zone-utilities) | Utilities for parsing, rendering, and manipulating EQ zone files | -## Related Repositories -* [ProjectEQ Quests](https://github.com/ProjectEQ/projecteqquests) -* [Maps](https://github.com/Akkadius/EQEmuMaps) -* [Installer Resources](https://github.com/Akkadius/EQEmuInstall) -* [Zone Utilities](https://github.com/EQEmu/zone-utilities) - Various utilities and libraries for parsing, rendering and manipulating EQ Zone files. - -## Other License Info - -* The server code and utilities are released under **GPLv3** -* We also include some small libraries for convienence that may be under different licensing - * SocketLib - GPL LibXML - * zlib - zlib license - * MariaDB/MySQL - GPL - * GPL Perl - GPL / ActiveState (under the assumption that this is a free project) - * CPPUnit - GLP StringUtilities - Apache - * LUA - MIT ## Contributors