diff --git a/README.md b/README.md index ada54ef..3973ed6 100755 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # HISP - HorseIsleServer Program + + [![Build](https://github.com/islehorse/HISP/workflows/build/badge.svg)](https://github.com/islehorse/HISP/actions?query=workflow%3Abuild) HISP is a "Server Emulator" for Horse Isle 1 @@ -10,6 +12,29 @@ well they essentailly run off "Server Emulators". **tl;dr, think "Club Penguin Rewritten" but with Horse Isle.** +# Installation: + +- Linux: + +Install on Ubuntu via APT: +``` +sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 34F644BC70C746CE48139C595129317F33AE659C +sudo add-apt-repository 'deb http://deb.silica.codes debian main' +sudo apt update +sudo apt install hisp +``` + +Install on Debian via APT: +``` +sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv 34F644BC70C746CE48139C595129317F33AE659C +sudo bash -c 'echo "deb http://deb.silica.codes debian main">>/etc/apt/sources.list' +sudo apt update +sudo apt install hisp +``` + +Then simply edit /etc/hisp/server.properties & change to correct database credentials +and start the server using ``systemctl start hisp`` + # Commands (legend: <> Required, [] Optional) ``` @@ -73,39 +98,6 @@ well they essentailly run off "Server Emulators". !DANCE ``` -# Noobs Package (For people who go WTF IS A SQL ?) -- Download HISP-N00BS zip -- Open the HISP-N00BS executable -- Within a few secs should now be playing Horse Isle. - -# Normal Setup (I want to actually run a server). -- Download the latest Windows or Linux binary. -- Setup a SQL Server, (eg, MariaDB). -- Setup a webserver with PHP8.0, intl and mysqli modules (eg, Apache). -- Create a database for the master site, and for all game sites you may have -- Copy files from the binary ZIP's www/master-site into your webserver. - have a separate virtual host for each www/game-site. -- Edit each game-site/config.php to have your SQL login information. - Change the server host to your public IP or a Domain that points. - to it and also change the HMAC Secret -- Edit master-site/servers.php and put each server your hosting - in the array. this is what will appear in the server list -- Edit master-site/config.php and set your SQL Server credentials, for the master-site - and change the hmac_secret to match that of every game-site -- For each server, run the HorseIsleServer binary. on first run, it will - crash due to trying to connect. But will create a "server.properties" file, - as well as a CrossDomainPolicy.xml, Edit server.properies and change the DB connection. - to your SQL server credentials- Change whatever other settings you want there as well. -- Run HorseIsleServer again and this time it will connect to the server and start up. -- Create an account on the master-site/ webserver. - And login using game-site/Horseisle.php, -- That's it your now running HISP Server. - Forward the port you used for the server and 80 for the webserver. - And people can login over the internet. - -- You can give yourself admin by executing ``UPDATE Users SET Admin='YES' Moderator='YES' WHERE Username=''`` - on the master database, (and any game databases) - # Depends HISP Depends on a SQL Server, its been tested and known to work specifically with MariaDB, https://mariadb.org/