README.md

HoloRPG

Multi-platform MMORPG text-based game for players to hunt on the go. The game is revolved around the concept of players placing bounties on each other, competing to be the richest on the leaderboard.

Table of Contents

• Features
• Platforms
• Development
  • Environment variables
  • Configuration
  • Installation of dependencies
• Contribution
  • Commit messages
• License

Features

Feature	Description	Released
Bounty	Place bounties on other players to make them lose their wealth	✔️
Leaderboards	View the global standings of players	✔️
Shop	Purchase in-game items to enhance players' statistics	✔️
Properties	Maintain properties that generate hourly income	✔️
Class Selection	Choose individual classes with unique statistics	❌
PvP	Attack players that are not on the bounty list to plunder their wealth	❌
Stocks	Gain additional income through trading stocks or receive dividends through passive stocks	❌
Friends	Forge meaningful connections/aliances to take down other players	❌

Platforms

Below is a list of platforms that is currently supported:

Platform	Supported
Web App	✔️
Discord	❌
Telegram	❌

Development

Environment variables

Environment variables are required to be injected at at build time.

• frontend/.env.example
• backend/.env.example

Simply rename .env.example to .env with the necessary configurations and place it in the root directory of each folder

Configuration

• Refer to docs/frontend for details
• Refer to docs/backend for details

Installation of dependencies

Frontend

cd frontend
npm install

Backend

cd backend

# Usage of Virtual Env
python3 -m venv .
source venv/bin/activate

# Installs dependencies
pip3 install -r requirements.txt

# Migration of MySQL DB
python3 manage.py makemigrations
python3 manage.py migrate
python3 manage.py loaddata data.json    # Load fixtures

Contribution

HoloRPG is open to any inputs, whether it's:

• Reporting an issue
• Discussing the state of the code
• Submitting a fix
• Proposing new features
• Becoming a maintainer of the project

Feel free to contact me on Discord at xDevolution#3059.

Commit messages

This project is transiting into the conventional commits standard. Do kindly follow the specifications specified in here prior to a pull request.

License

By contributing to HoloRPG, you agree that your contributions will be licensed under the LICENSE file.