A basic, simple to understand and step by step guide to setup the project.
This guide it's also included on the project by default, as a .txt file.
Guide - Windows
- Download the essentials files.
Suggested ISO: Windows 10 LTSC version.
Shaiya Essentials offers the installers of the following suggested and recommended program versions to run the project:
SQL server EXPRESS 2022
SQL server MANAGEMENT STUDIO 20.2.1, an stable and easy to use version of the manager.
First steps/ Installing SQL server:
- Create two new folders on the C:/ Disk, Database and ShaiyaServer
- Install SQL server EXPRESS 2022 included in the project.
- Once on the installator select 'CUSTOM' installation. (IMPORTANT)
Install as usual, do not install additional components since you don't need them, this includes Azure and Updates.
At INSTANCE CONFIGURATION, choose 'DEFAULT INSTANCE (MSSQL)' (IMPORTANT)
At DATABASE ENGINE CONFIGURATION, choose 'MIXED MODE' , here you select the password for your database. (IMPORTANT)
You can use any password you like, but essentials suggest shaiya123 for a local server.
Once you installed it, run the installer of SQL server MANAGEMENT STUDIO 20.2.1 also included on this project (SSMS-Setup-ENU)
There is nothing special about the installation, just let it run.
Next Step: TCP config
- Open SQL SERVER CONFIGURATION MANAGER 2022, it's already installed on your system and have a red icon.
- Navigate to SQL SERVER NETWORK CONFIGURATION.
- At 'PROTOCOLS FOR SQLEXPRESS' , enable TCP/IP.
- Right click 'TCP/IP' and look for Properties, then IP adresses and enable the IP 127.0.0.1 and save.
- At 'SQL SERVER SERVICES' search for SQL SERVER (MSSQLSERVER) and RESTART it, should take a few seconds.
Close the program once you done.
Now to the database/server files setup:
- Copy your .bak archives from the essentials folder to the Database folder.
- Copy your PSM_Client and PSM_Server folder on the essentials folder to the ShaiyaServer Folder.
- Go to PSM_Server and open ps_passwordEnc with admin rights.
- Put your default password to get an encrypted text, remember you choosed the password on the installation (shaiya123 by default)
- Copy the encrypted password and navigate to PSM_Client/Bin/Config and edit all the inis with the new password.
Leave the username as shaiya
Ps_session don't need any edition.
- Go to PSM Client and open PSM_AgentInstall with admin rights, just click Ok on the two options.
A restart it's not needed, unlike what the description says.
- Go to PSM Server and open PSMServer_AgentInstall with admin rights, same process.
Exit the program and now open the MSSQL server management studio, always with admin rights:
- Open the database and go to 'Security' then 'Logins', you need to edit the default username 'sa'.
Just right click and choose rename, you should put here shaiya (The standard username for the files) or the username you want.
Note that this username needs to match with the .INIS on the previously configured folder.
- Now install the databases:
Click the Databases folder and select 'RESTORE DATABASE'.
On the new window choose Device and navigate to the c:/ folder where you left your .baks.
Upload ONE BY ONE (You can't just upload all at the same time) to the database.
Once all databases are uploaded, you can close the MSSQL.
Now you are ready to turn on the server and start playing:
- Go to PSMServer_Mgr on the PSM_Server folder and open with admin rights.
It's highly advisable to edit the propeties of the program to always open it with admin rights.
- You see here several services with green 'X', go to Server Setup and click 'Service Install all'.
After a few seconds, the X should now be paused services.
- Choose 'Start all server services'.
If you do everything ok, the paused serviced now be green arrows and your server it's online.
You can now login to the game as usual.
Essentials offers some admin and normal account by default to play on the test server:
admin1 admin1 up to 5 (Like admin3 admin3)
norma1 normal1 up to 5 (Like normal3 normal3)
Public Server Guide
Once you have your local server configured you may want to play it with friends, or setup a public server at some point.
This guide supposes you're not inside a VM, but a normal desktop or a VPS with a proper stable IPV4.
How can i make my server public?
- Go to firewall advanced config and click IMBOUND RULES to add a new rule.
* Rule Type = Port
* Protocol and Ports = TCP
Specific local ports = 30800,30810
* Action = Allow the connection
* Profile = All by default
* Name = Any name you want
This enables external PC's to access your GAME and LOGIN ports (30800,30810) in order for people to play.
Both ports should always remain opened in order to run a public server.
- Go to the website https://whatismyipaddress.com/
The IPV4 it's your local stable public IP, the one you need to use so people can join your server. Copy the IP!
It's not different on a VPS, but in that case, you can already check that on the remote desktop upper bar.
- Go to your server files on PSM_Client>Bin>Config>ps_game.ini file
Change 'PUBLIC IP' from 127.0.0.1 to your previously copied IP.
- Open the game.exe of your client with HxD and search for 'config'
You should see the IP 127.0.0.1, change it for your IPV4 IP.
Respect the placement and typing, it needs to be precise.
Save the executable and send it to your friends, so they can use a game.exe with the right IP to connect.
Alternative, send them the whole client if needed.
- Turn on the server so they can play.
For VPS/Public servers:
- The Port 1433 is absolutely core and absolutely dangerous.
It's used for SQL, you are gonna use it for your web if you use one, or to connect shaiya studio remotely.
In any case, add rules so ONLY YOUR HOME IP OR SPECIFIC IPS (Like the web) can connect to that port, this is a gold security rule you always need to follow.
1433 port it's not needed for the game to run or people to play.