Alfheim Project

Build status:

Table of Contents

• What is Alfheim Project?
• Helpful Links
• Prerequisites
• How do I get started?
• Todos
• Contributors

What is Alfheim Project?

Alfheim Project is a Control Panel for a robust Massively Multiplayer Online Role Playing Game (MMORPG) Ragnarok Online. Written in Python. The project supports two biggest open-source Ragnarok Online emulators:

• Hercules
• rAthena

Helpful Links

• Discord Server
• API documentation
• Python
• Django
• Django Rest Framework

Todos

• Multilanguage support
• Web vending database endpoint
• Web itemdb/mobdb endpoint

Prerequisites

Before installing Alfheim Project, you will need to install certain tools and applications. This differs between the varying Operating Systems available, so the following list is broken down into Windows and Unix (incl. Linux) prerequisites.

Windows

• Python 3.6+
• MySQL server
• MySQL client (not required, you can use cmd or other shell)
• GIT

Unix/Linux/BSD (names of packages may require specific version numbers on certain distributions) current links are for Ubuntu.

• Python 3.6+
• MySQL server
• GIT
• libmysqlclient (mysql-devel)
• In additional you may need (python3-dev) package

How do I get started?

This section is a very brief set of installation instructions. For more concise guides relevant to your Operation System, please refer to the Wiki (not completed section!).

Windows

• Install the prerequisites.
• Clone Alfheim Project repository (see GitHub) using a git client, into a new folder.
• Configure MySQL server if not already installed
• Complete this section

Unix

• Install the prerequisites.
• Clone Alfheim Project repository (see GitHub) using a git client, into a new folder.
• Configure MySQL server if not already installed
• Install additional prerequisites if needed (sudo apt-get install python3-dev, sudo apt-get install libmysqlclient-dev libmysqld-dev for Ubuntu)
• Complete this section

Configure Alfheim Project

• Run cd path/to/project
• Run travis.sh
• Open and configure alfheimproject/conf/config.json
• Open and configure alfheimproject/conf/secrets.json
• Open and configure alfheimproject/conf/donations.json
• Run python3 manage.py verify_setup and follow instructions
• Run python3 manage.py migrate
• Run python3 manage.py runserver HOST:PORT

If you're having problems with starting Alfheim Project, the first thing you should do is check what's happening on your consoles. More often that not, all support issues can be solved simply by looking at the error messages given.

Contributors

• kubix
• outofgamut
• Arnoldicus