Skip to content

EvilGenius13/ArcaneNexus

Repository files navigation

ArcaneNexus

ArcaneNexus is a custom game launcher inspired by World of Warcraft. It integrates a client launcher, server management, and a manifest generator, providing a unified platform for an enhanced gaming experience.

🧙‍♂️ Features

  • Game Launcher: Built with Electron, offering a user-friendly interface to launch and manage game clients.
  • Server: An Express-based server that handles game manifests and client-server interactions.
  • Manifest Generator: A tool to scan directories and generate JSON manifests for game files.
  • (Coming Soon) Docker Support: Easily deploy and manage the server using Docker Compose.
  • Modular Monorepo: Organized with npm workspaces for streamlined dependency management and development.

💻 Web Demo

If you want to see a web version of the app with limited functionality, you can check it out here.

📁 Directory Structure

ArcaneNexus/
├── packages/
│   ├── server/
│   │   ├── Dockerfile
│   │   ├── docker-compose.yml
│   │   ├── package.json
│   │   └── src/
│   ├── generator/
│   │   ├── package.json
│   │   └── src/
│   └── launcher/
│       ├── package.json
│       └── src/
├── package.json
├── README.md
└── .gitignore

🚀 Getting Started

📦 Prerequisites

  • Node.js (v14 or later)
  • npm (v7 or later)
  • Docker (optional, for server deployment)

🛠️ Installation

  1. Clone the Repository
git clone https://github.com/EvilGenius13/ArcaneNexus.git
cd ArcaneNexus
  1. Install Dependencies
Copy code
npm install

This command installs dependencies for all workspaces (server, generator, launcher).

⚙️ Configuration

  1. Server Configuration
  • Navigate to the server directory:
cd packages/server
  • Create a .env file based on .env.example and configure your environment variables.

📝 How to generate a manifest and run the launcher [Development doc]

  1. In /packages/generator, create a .env file based on .env.example and configure your environment variables.
  2. Cd into /packages/generator and run node generateManifest.js to generate the manifest.
  3. Cd back to root folder then run npm run build:laucher.
  4. Run npm run start in root to start the server.
  5. Open application generated in packages/launcher/dist and enjoy!

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published