Skip to content

Isangeles-Softworks/openelwynn

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Introduction

OpenElwynn is an 2D RPG game placed in well known Elwynn Forest area from WoW.

Game comes with TCP game server, allowing any number of players to join and play together.

The game uses Flame engine and Mural 2D GUI as the user interface.

This repository contains configuration files for the game server and interface, a makefile for building/updating the game, and a start script that starts the game by running the local game server, game AI, and user interface.

Screenshots

Installation

To install pre-build game download and unpack the game build for your platform:

You can find all latest builds here.

Run

Start the game by executing the start or start.bat(Windows) executable:

./start

You can also start the game without the local server(single player mode) by executing gui or gui.exe(Windows) executable:

./gui

Build/Update

You can build the game from scratch yourself or update all core components and game content to latest versions.

Before performing the build/update you need to obtain specific dependencies.

Basic dependencies are Git, Go, Make, OpenGL development libraries, and some audio development libraries.

For more details check the sub-section for your platform below.

Linux

On Fedora-like distribution install: go libX11-devel libXcursor-devel libXrandr-devel libXinerama-devel mesa-libGL-devel libXi-devel libXxf86vm-devel alsa-lib-devel.

On other distributions, you need to install the equivalence of these packages.

macOS

Install Go and Xcode or Command Line Tools for Xcode.

Windows

Install Git, Go, MinGW, and Make.

You can easily install all these dependencies with Chocolatey.

Run build/update

After installing all dependencies use make to build/update the game.

To build the game:

make build

To update existing installation:

make up

Game content

Game content is placed in the data/modules/elwynn directory.

Game content alone is hosted in a separate repository here.

The whole game content is a Flame module.

Read Flame repository description and documentation for more details about using and configuring game modules.

Interface

The game uses Mural as the 2D user interface.

gui executable start the 2D user interface.

Configuration values for the user interface are stored in the .mural file.

Read Mural repository description and documentation for more details about using and configuring the game interface.

Multiplayer

The game uses Fire as the game server.

server executable starts game server on the address specified in the .fire configuration file.

Other players can join the game by configuring their GUI with the address and port of the game server in the .mural configuration file.

After connecting to the server, players need to authenticate with a user ID and password.

Users can be created by adding a new directory in the data/users with the .user file containing the password. The user directory name is used as a user ID.

Read Fire repository description and documentation for more details about using and configuring the game server.

If you interested in setting up the game server, check the docker image for OpenElwynn server.

AI

The game uses Ignite as game AI.

ai executable start the game AI.

Configuration values for AI are stored in the .ignite file.

Read Ignite repository description and documentation for more details about using and configuring the game AI.

Contact

License

Copyright 2021-2024 Isangeles Softworks <[email protected]>

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

About

2D RPG game placed in well known Elwynn Forest area

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published