EQ: Requiem is a project that brings EverQuest to the browser using the BabylonJS Engine and go. Contributors are welcome, please reach out in discord:
Discord: https://discord.gg/ptJxyejwXt
EQ Requiem will always remain open source and welcomes contributions of all kinds. Here are steps to get local development set up:
- Go version 1.24 https://go.dev/doc/install
- MySQL
- NodeJS + npm https://nodejs.org/en/download
- Local port 443 available (This could be worked around but we're not there yet)
- VSCode https://code.visualstudio.com/download
- Make (Windows users can just use CLI commands instead but Make makes things easy)
- From the root directory, run
cd client && npm install - Run the client development server with different options
npm run start:prod- This allows you to do client-side code changes without a server spun up and depends on the live server to be upnpm start- This will try to connect to your locally running go backend on port 443npm run sage:dev- This is for using Sage to convert assets in runtime and requires installing the Sage core module as a sibling repo of this repo https://github.com/knervous/eqsage
In order to start the server, you must first install MySQL and seed the database from the latest template db eqgo
- Download the dump file: https://eqrequiem.blob.core.windows.net/dev/eqgo.sql.zip
- Extract it anywhere
- CD to the directory the
dumpfile.sqllives in and runmysql -u [username] -p[password] -e "CREATE DATABASE IF NOT EXISTS eqgo"mysql -u[username] -p[password] eqgo < dumpfile.sql
- Verify the database is populated and running
- Under the directory
server/internal/configthere's a template calledeqgo_config_template.json, copy that and rename iteqgo_config.json - Fill out all the necessary credentials to connect to your MySQL DB
- Go to
server/internal/configand generatekey.pemwithopenssl genpkey -algorithm RSA -out key.pem -pkeyopt rsa_keygen_bits:2048
- To avoid error when using
makeorgo run, create a Discord application, get your bot token, and paste it intodiscord.txtinsideserver/internal/config
- For the rest of the commands you should be cd into
serverin the root directory - If you have Make, you can run
make sto run the server, see the Makefile for the rest of the commands - If you don't have Make (on Windows) then you can run
go run ./cmd/serverto start the server - If you want to debug in VSCode, there are launch options to start normally and with local quests. Local quests allow you to hot swap quests out every time you save.
You are now ready to connect and should be able to visit the local webpack development server and connect to your local backend