Merge branch 'master' of https://github.com/islehorse/HISP

README.md

@@ -1,7 +1,5 @@
 # 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          
@@ -12,9 +10,21 @@ well they essentailly run off "Server Emulators".
 
 **tl;dr, think "Club Penguin Rewritten" but with Horse Isle.**
 
+
 # Installation:
 
-- Linux:
+Understand that there are differnet verisons of the HISP package;
+
+HISPd - reimplementation of the Horse Isle 1.0 Server Software 
+
+N00BS - a launcher for joining Multiplayer or running a local server for offline singleplayer play (deprecated)
+
+MPN00BS - Same as N00BS but multiplatform
+
+Game relies on a SQL Server, any should work, but i have only tested it with MariaDB, 
+(and i guess SQLLite for the one used in the launcher version)
+
+- APT:
 
 Install on Ubuntu via APT:
 ```
@@ -35,6 +45,29 @@ sudo apt install hisp
 Then simply edit /etc/hisp/server.properties & change to correct database credentials
 and start the server using ``systemctl start hisp``
 
+- Manual Install:
+
+If you do not want to use APT, or are on Windows or MacOS, then you can simply download the latest HISPd binary:
+here https://islehorse.com/download/
+
+Run it and edit server.properties in the same folder as HISPd
+
+- Websites:
+
+Website is built in PHP 8.0 and based on the original Horse Isle Game Website
+requires the following PHP modules to be loaded; "intl", "mysqli" and "mysqlnd" on Ubuntu
+
+you must edit config.php and server.php to configure before it'll work properly.
+and is required to sign-up to the private server
+
+the master-site (equivilent to master.horseisle.com) can be found here:
+consists of sign up page, and server list, 
+https://server.islehorse.com/binaries/download/HISP-Web-Master.zip
+
+and the game-site:
+contains the actual game client .SWFs themselves
+https://server.islehorse.com/binaries/download/HISP-Web-Game.zip
+
 # Commands     
 (legend: <> Required, [] Optional)
 ```
@@ -97,11 +130,6 @@ and start the server using ``systemctl start hisp``
               <locationame>        
     !DANCE <udlr>       
 ```
-
-# Depends
- HISP Depends on a SQL Server, 
- its been tested and known to work specifically with MariaDB, https://mariadb.org/
- Set its information into server.properties or the server will just crash on first run /-/
  
 # Building
  Building the server from source requires Microsoft .NET Core SDK, targetting version 7.0 https://dotnet.microsoft.com/download/dotnet-core
@@ -111,8 +139,12 @@ and start the server using ``systemctl start hisp``
  
  NOTE: At this current time, building projects targeting .NET Core 7.0 inside Visual Studio requires Visual Studio 2022 PREVIEW and does not work in the stable build
  
-# Web Server
- Theres a bunch of saved files from the Horse Isle 1.0 website, as well as some basic functionality to make it work
- like the original site, the files are in the "HorseIsleWeb" folder, it requires PHP 8.0, with the modules "intl" and "mysqli"
  
- - Li
+ # Credits
+ 
+Li (They/Them)
+
+Supertiger (He/Him)
+
+Olebeck (They/Them)
+