# hearthmod

Make HS fun again

Components

hm_lobbyserver - hearthmod lobby server

hm_gameserver - hearthmod game server

hm_base - hearthmod base library

hm_client - hearthmod client

hm_database - hearthmod latest database snapshot

hm_sunwell - hearthsim custom card generation

hm_stud - tls un/wrapper

hm_nginx - nginx web server

hm_web - hearthmod web interface

Guide

Clone hearthmod software stack

git clone https://gitlab.hsmod.xyz/omdagny/hearthmod

Docker container

Run

cd hearthmod/
docker-compose up --build

builds and starts the hearthmod container with all of the required dependencies.

bash docker_ctl.sh bucket_create

creates a bucket in couchbase.

bash docker_ctl.sh bucket_restore

restores the latest database snapshot/populates it.

bash docker_ctl.sh compile

compiles and installs the entire hearthmod server stack.

bash docker_ctl.sh start

starts the hearthmod server stack.

bash docker_ctl.sh stop

Ubuntu

Run

cd hearthmod/
bash host_ctl_ubuntu.sh uninstalled

which compiles and installs the entire hearthmod stack. Also, it doesn't check for you local couchbase, nginx or stud instances. If you don't want to mess them, consider using virtual environment or modify installation script. If you don't run ubuntu or debian, please consider installation script alteration that suits your distro and creating an upstream pull request. Script host_ctl_ubuntu.sh was only tested on Ububtu 16.04.

Once compiled, run:

bash host_ctl_ubuntu.sh start [ip]

where IP is address of your gameserver (your current IP in most cases) and you can play.

Hosts file:

If you don't want your hearthstone client to connect to hearthmod.com you must edit your hosts file by adding the following line:

<yourip> hearthmod.com

Hosts file location varies depending on OS.

Linux:

/etc/hosts

Windows:

c:\Windows\System32\Drivers\etc\hosts

Running the clients:

cd hearthmod/hs_client1/hearthmod_client/linux
./hearthmod

and

cd hearthmod/hs_client2/hearthmod_client/linux
./hearthmod

By running two instances of hearthstone you can play by yourself and develop or test stuff.

To create or modify cards, accounts, decks; go to http://localhost/ .

Troubleshooting:

TODO: Edit this to accommodate docker changes

web server error log file:

tail -f /usr/local/nginx/logs/error.log

gameserver and lobbyserver log files:

./hearthmod/hm_log/*

Pull requests are more than welcome.