Skip to content

Latest commit

 

History

History
266 lines (186 loc) · 13.6 KB

README.md

File metadata and controls

266 lines (186 loc) · 13.6 KB
Raw

Hybrasyl Server

Create a Game Account
Project website Bug Tracker Server Public World Data Road Map

Welcome to Project Hybrasyl!

Our aim is to create a well-documented and exceptionally accurate DOOMVAS v1 emulator (example: Dark Ages).

For Players

If you are looking to play Hybrasyl, you're in the wrong spot!
Create an account, and join us as we implement Kennerly's vision with new technology and better gameplay.

For Developers, Contributors, Server Hosts

This document is intended for developers; if you're interested in using a released version of Hybrasyl server, please check our Github releases page. Although we do not currently provide installer packages, we do provide Docker images which can be quickly used to get started. Generally, if you use the Hybrasyl launcher, our staging server is almost always online - production will be online once we implement more features!

Hybrasyl is a work in progress. A lot of the functionality you would expect from a playable game is not yet implemented. You can see open issues in our GitHub issue tracker, look at our current TODO/punchlist or check out recent project news.

The instructions in this document will guide you in setting up and running the latest version of Hybrasyl and connecting a client for testing purposes. Note that this project does not provide game content (properly configured items, maps, warps between maps, etc); it comes with a set of examples that will allow you to log in but not enough to come close to playing a real game.

It is our hope to release a content editor at some point in the future to make the process of adding content to a server much easier.

Requirements

You will need three things to use Hybrasyl, in addition to the server itself:

Terminology and key concepts

There are three processes that need to be properly configured in order to connect a Dark Ages client to your own Hybrasyl instance:

  • The launcher (which modifies the Dark Ages client to get it to connect to the server).
  • The game server (what you're looking at now)
  • A running instance of Redis, which will be used for storing state data.

This tutorial assumes that the launcher (DA client) and Hybrasyl server will be running on the same machine. Redis can be located anywhere, as long as Hybrasyl can reach it (it could even be an Amazon Elasticache instance).

Game Server (Hybrasyl)

The game server maintains all game metadata and state, including registered character names, mobs, towns, spawn points, items, and a bunch of other game-related data. The Hybrasyl server retrieves state data such as players, player inventory, messageboards and mailboxes from its companion Redis server at runtime; XML is processed when the server starts up for actual world data (items, maps, mobs, etc).

The server runs on three TCP ports (2610, 2611, and 2612 by default).

To get started with the server, you have two options:

  1. The easy way - using Docker and/or Docker Compose

    If you have docker-compose, starting a working server involves three steps:

    a. Clone the Hybrasyl server repository

    `git clone --recursive https://github.com/hybrasyl/server.git`

Adding `--recursive` here ensures that you also check out [Ceridwen](https://github.com/hybrasyl/ceridwen), our sample data repository, which has starter items/castables/etc.

    b. Edit the config.xml as needed (it's in contrib/config.xml)

    In particular: You will need to configure ExternalAddress to be the IP address of your workstation running Docker. This is also the IP address you'll use to connect with Spark. Unfortunately, the protocol Darkages uses isn't NAT-aware (Hybrasyl provides ExternalAddress in order to make this possible) so we need to provide it with the right address. For a public-facing server, this will be the publicly routable IP address.

    c. Start the servers

    docker-compose-up

This will download and run a Redis server image and Hybrasyl’s Dockerhub image, and start both. You’ll be able to login to it immediately using Spark!

Alternatively, if you are more comfortable running servers, you can download and run a quick start image if you want to provide your own Redis server. The quick start image includes a copy of our example data that you can use to instantly get into a test server.

You'll need to edit your config.xml so that DataStore points to the right IP / hostname.

Lastly, a script is also provided (build-image.sh for rebuilding the Docker image, if you want to do so).

  1. The harder way

a. Install Redis

Hybrasyl uses Redis to store player state and mailboxes. If you are using Ubuntu/Debian, apt install redis-server. For Windows, you can either run Redis using WSL or you can downoad and install the Windows installer for Redis 2.8 from the MSOpenTech releases page. There is no requirement for Redis to be local to the server; it can be hosted anywhere, though we recommend it is located on the same network segment for better security. Redis should work out of the box with Hybrasyl with its default settings. You will need to ensure that the Redis port, TCP/6379, can be accessed from the server running Hybrasyl; you may need to grant access or open ports.

b. Create and populate your base directory

On Windows, this is %userprofile%\documents\Hybrasyl. On GNU/Linux or OSX this is ~/Hybrasyl for whatever user is running the server. Take a look at the community-maintained database for XML and scripting. This has more than enough XML and scripts to get you started. You can put the contents of that repository directly into your Hybrasyl data directory and start the server.

c. Update your configuration

For your server configuration, you can start with our [annotated](https://	github.com/hybrasyl/server/tree/main/contrib/config.xml) example for your 	config.xml which will help you get up and running quickly.

d. Install and run Hybrasyl

(see Running Hybrasyl below).

Running Hybrasyl

Hybrasyl Server is a .NET 6 console application, which means it can be run on a variety of platforms (Windows, Linux, OSX).

If you aren't using Docker, we provide a systemd unit file is provided to start the server on Ubuntu 18.04+. In any case, download the latest release for your platform. This can be unpacked into /srv/hybrasyl on Linux or a directory of your choosing on Windows.

Once downloaded, either run the server directly (Hybrasyl.exe or Hybrasyl on Linux) or, if you’re running on Linux or a WSL distribution that uses systemd, install the unit file in /etc/systemd/system/hybrasyl.service and start Hybrasyl:

service hybrasyl start

To start the server on OSX or Linux for debugging and testing, you can run dotnet run from the hybrasyl directory (e.g. where Hybrasyl.csproj lives.

Compiling the Game Server

The process for compiling Hybrasyl is detailed below.

  1. Install either Microsoft Visual Studio. or Microsoft Visual Studio Code.

    For Visual Studio, the Community Edition is free and capable of compiling all the needed projects (server, launcher), but you don't strictly speaking need this any longer - you can also just edit C# code in VS Code.

  2. Download and install the .NET 6 SDK.

    Currently, Hybrasyl uses .NET 6. In order to do development, you need both the SDK and runtime; to simply run Hybrasyl, you just need the runtime.

  3. Download Spark (the launcher from above) and clone the server repository to your local machine using a git client, with Visual Studio or VS Code's built-in integration, or with GitHub Desktop

  4. Update and rebuild packages.

    Open the Hybrasyl Server solution (Hybrasyl.sln) in Visual Studio and update all NuGet packages (just building it will do this). If using VS Code / via command line, run dotnet restore and dotnet build in the same directory as the Hybrasyl.csproj file. This step will also build the XML/XSD data library.

  5. Build Hybrasyl.

    The default settings should be adequate for most system setups. Should you wish to compile an distributable / standalone executable, run the following from the command line: dotnet publish -c Debug -r win10-x64 or dotnet publish -c Debug -r linux-x64

Now that your setup is complete, you should be able to use Spark to connect to it (after opening Hy-brasyl Launcher.sln and building the project). Launch Spark and type in localhost in the "Server Hostname" field.

You should now be able to connect to your Hybrasyl server, create a new character, and log in! If not, well, take a look at the section on getting help.

Logging in

Log in to your new server by launching Spark. Point it to a local Dark Ages client installation, enter localhost into the server hostname field (if running locally), or the IP address of your Docker host, and launch. Spark will ask you for a local Dark Ages client executable; you must have the latest client installed in order to continue. Once launched, you should see a Hybrasyl welcome screen in place of the standard Dark Ages welcome screen.

Congratulations -- you're connected!

Create a character and log in the same way you would on a production server. You should find your Aisling in an inn and ready to explore the world.

Testing tips and other notable resources

  • There are a number of admin flags that can be used for common tasks like creating items, teleporting, or changing level and class. Certain flags require that you be registered as a game master.

  • Try typing /item Stick when you log in to add a stick to your inventory. You can add any item that is a valid Item XML file in xml/items in your world directory (you did use ceridwen to start, right?)

  • You can learn skills and spells by using /spell, for instance, /spell Assail.

  • Warps are links between locations on the map. You can add or remove warps in a map file (e.g. xml/maps/ExampleVillage.xml).

  • You can add new items by creating new XML files. The example items should provide good models to follow; there are also XSD files for the XML structure in the SDK repository. We hope to make a world editor available eventually.

Help! Something isn't working!

We're here to help!

The project maintains a public Discord server and it should be your first go-to for asking questions. Remember that Hybrasyl is a volunteer project, not a job; we'll try to get to your questions as soon as we see them.

A Note on Licensing

Please note that Hybrasyl Server, along with most of its components, is licensed under the GNU Affero General Public License, version 3 (AGPLv3). This means that, if you use this software to run a server that other users can connect to, you are required by the license to release the corresponding source code, which means that any and all modifications you make to the server software are also licensed under the AGPLv3. Read more at gnu.org.

By using this license for Hybrasyl, our intent is to foster a vibrant community whose development and progress are open and available to all.

Please note: these restrictions do not apply to in-game Lua scripts and/or XML world data you may create for your server. Whether or not you distribute that content is up to you.

Contributing

We welcome contributions to the project! We encourage new developers to visit us on Discord or send some emails to the developer list and get to know us first, especially if you plan on tackling a substantial feature or change. Hybrasyl follows the standard Github fork model, so fork us today and submit a PR!

Please note that in order to contribute to the project, you must agree to the terms of our contributor agreement.