Game

Public repository coming Soon™

Sitekick Remastered

Welcome to the repository for Sitekick Remastered!

Setting up your Local Environment

Required Software

1. Unity Hub
2. Unity 2021.3.8f1
3. MySQL (I recommend downloading the MySQL Installer and installing the items through there)
4. Visual Studio or VSCode (VS Code will require some more setup to utilize the C# Server Solution)

Creating your Local Database

1. Go through the MySQL Server setup and create a local mySQL database on port 3306.
2. Once you have that created, run the schema and data files to get the database filled with the correct tables and data.
3. You'll need to manually add your account to the accounts table. One of the current developers should be able to get your the values you need for your password and password_salt. Make sure you have Verified = 1
4. Once you have that and your database is running we can move on to setting up the Server

Running the Local Server

1. The Server solution is located in /Server/Project/SitekickServer.sln.
2. You will need to update your Server.config file to match your local database created in the last step. The file is located at /Server/Project/SitekickServer/Server.config
3. Once you have the updated Server.config you should be able to run the Server either via your IDE or by the executable itself (created after you build it for the first time). Once it's running it should look like this

NOTE: Building the Server Solution after changes

If you make any changes to the SharedServices project you'll need to build the solution in Release configuration so it copys the .dll file to the correct area for Unity.

Setting up the Local Environment in Unity

1. To open the project in Unity you'll need to select the Sidekick.
2. Once you have it open you'll need to update a few variables before you run it for the first time.
3. Go to File > Build Settings and it should be set to Windows, Mac, Linux. Check off the Development Build box. It should look like this
4. Go to Player Settings at the bottom of the window above. Make sure the Version is set to the most current version.
5. Close out of these settings and navigate to Assests/Data/GameConstants.asset or search for it via the Search bar.
6. Set your Target Server to Local

Running in Unity

1. You do not need to build in Unity. You can utilize the Play functionality at the top of the screen.
2. To do this, navigate to Assets/Scenes and choose the Login scene.
3. Click on the Play button and it should start running in the Game display in Unity.
4. Login with your credentials that you manually input into the accounts table when setting up your database. It will cache your credentials as well.