Hi and welcome to the Heroes of Rain project! This manual will consist of 3 major parts I will explain:

1. Setting it up
2. The game source code
3. The website source code

For both of them I will explain what the general logic is and how it works.

====== Setting It Up

Website

In order for the website to run, it makes use of the following:

• HTML & CSS
• JavaScript
• PHP

To install the website part, you can just put all the files in a folder inside a web server that supports the previous list. This can be done using any FTP client that has access to the internet. It is important to note that the files should to able to have writing permissions.

Game

Developer

To be able to edit, build and run the game, the Unity Engine is required. This can be downloaded here: https://unity3d.com/get-unity

Unity is build in such a way that recognizes different versions and will give a message if it does detect so, giving further information on how to solve it. This means that any recent version of Unity is good enough. If that is not the case, the game is build in version: 5.3.4f1. ote that the Unity installer (at this moment) comes with a default code editor (MonoDevelop or Visual Studio). You can use this by default, or add your own if you want.

When Unity is installed, there are two major ways of opening the project. Firstly, you can run Unity and click "OPEN" in the project launcher. Select the root folder in which the project is placed. This is the folder where the .sln file is located. Secondly, you can tell Unity to open the project in a specific scene. You can do this opening the Scene file (.unity) inside the Assets/Scenes/ with Unity.exe.

Now that the project is openend in Unity, you can freely edit any of the assets. You can build a new version of the game by selecting File > Build Settings > Select "PC, Mac & Linux Standalone" > Build. If you want to change any build settings, like supported resolutions, this can be done by clicking "Player Settings" in the bottom left.

To run the game in the editor, you can simply press the big play button in the top center of the screen.

In order to connect the game with your webserver, you need to specifiy the URL to your "GetQueuedData.php" file. This file was installed during the installation of the website. You can specify this URL inside the RequestController.cs which can be found in Assets/Scripts/Controllers/. Inside the Start method (currently on line 32) there is a _url string where you can specifiy your URL.

If you want to test without internet or need for the webserver, starting from the introduction screen, you can send in characters manually. You can spawn characters with rainproofing measures by pressing the 1 to 7 keys. You can send in rewards by pressing the Q to Y keys.

Running The Game

The game is build to be run on a single desktop connected to a big screen. The desktop (or laptop) can be connected to a screen that supports inputs like HDMI, VGA, DVI, etc. Basically any cable that supports graphical transmission. It is very important to note, that every game instance is currently requesting from the same web server. So multiple game instances will request each other's queues. In order to fix this, every instance needs its own URL to request from. Meaning that for every game instance, there should be another copy of all the website files in a seperate folder.

====== The Game

Loop

I will explain the general loop in which the game functions and will mark important pieces in bold which I will explain after.

1. The game starts up
2. The splash screen is shown with all the relevant logos
3. The introduction screen is shown
4. It will wait for the first user input
5. The gameplay starts
6. Things happen based on user input and certain conditions
7. At 100% time the user input is stopped and the final cloud is spawned
8. The game will wait for the cloud to reach it's end
9. A highscore screen is shown
10. After 30 seconds, goes back to step 2

Important Notes

The introduction screen is shown: This is not really a unity scene on itself. The introduction screen is just the gameplay scene, but with a UI image overlay, The gameplay is paused while this image is shown.

Based on user input: This is a pretty important part. The players can send characters into the game via our website. This user data is saved on the web server in seperate files. Unity will send a POST request to the website, requesting all the user data. This happens in an customizable interval to relieve web bandwith usage. This data is retreived as a single long string containing all queued characters and rewards. This retreived string is processed and characters will spawn.

Certain conditions: The user input is not the only thing that can happen in the game. The game itself will also make stuff happen. First of all, rain clouds will spawn over time based on the level progression; where 0 means start of the round and 1 means the end. Secondly, these rain clouds will cause floods on certain points in the level if it rains to heavy; these points are indicated by a SewageDrain gameobject. Thridly, every so often a the game will send a character into the world to clean a part of the active floods if needed.

At 100% time: The timing of the game is based on our a calendar. The game will run X years in Y minutes and depending on these settings will run slowly or really fast. The code will calculate how many seconds 1 day is, and will count the days, weeks, months and years passed. Every milestone has it's own event which can be bound to (OnDayPassed, OnWeekPassed, etc). The Y minutes does currently not 100% correctly match the X years due a math error, so a 0% to 100% timer is shown in the bottom left corner of the screen.

Reach it's end: When the timer reaches 100%, all the active rain clouds will despawn and a super heavy rain cloud will spawn. Every rain cloud will spawn outside the screen and will move towards another point outside the screen. This position is based on a gameobject somewhere that has a collider. Spawned rain clouds will move towards a random position within this collider and thus giving them a random moving direction. Upon reaching this collider, they destroy themselfs.

On a last note, there is a gameobject called Controllers in the scene. It has several childs with attached scripts that control most of the game logic. Most settings can also be tweaked here, but some are specific and can be found in the prefab folder on their respective object.

====== The Website

Flow

I will explain the general flow of the website and mark important parts in bold.

1. The index page is loaded.

2. The users can fill in their name.

3. Users can now choose to either build a rainproof measure or take the quiz for a reward

4. Upon choosing to build a rainproofing measure

5. A screen is shown that lists the rainproofing measures

6. Upon selecting which measure to build, the code saves this user request (A)

7. Upon choosing to take the quiz for a reward

8. A question is shown

9. Upon selecting the answer, if it's correct, the a page with rewards is shown

10. A screen is shown that lists the rewards

11. Upon selecting which reward to use, the code saves this user request (B)

Important Notes

Every PHP file will echo a result based on a the request. This can be the requested data, or a number indicating an error. These results can be find in the top of the PHP file itself.

Saves this user request (A): The page will submit a form request into a PHP file, which will check what type of rainproofing measure has been selected. If no error occured, the code will save the player name and the selected measure into a file. This file ([random_number].character) is placed at /characters/ and contains a string with the data. The way this data is saved, can be found inside the PHP file.

A question is shown: There is a PHP file that has all the questions in it (hardcoded). Whenever this file receives a request asking for a question, if there are no errors, it will echo a string consisting of a random question including with the answer. The way this question is echo'd, can be found inside the PHP file.

If it's correct: The same PHP file that will echo a random question, is also responsible for check if a question is correct. All the questions are hardcoded into this file. The submitted question and answer is compared against the question data, and a result will be echo'd if there are no errors. The way this data should be submitted, can be seen in the PHP file.

Saves this user request (B): The page will submit a form request into a PHP file, which will check what type of reward has been selected. If no error occured, the code will save the player name and the selected reward into a file. This file ([random_number].reward) is placed at /rewards/ and contains a string with the data. The way this data is saved, can be found inside the PHP file.