# User Manual Haptiplan

This user manual is for the web application *Haptiplan*. The [player](#Player-Manual), [gamemaster](#Gamemaster-Manual), and [admin](#Admin-Manual) roles have different functions, described in their respective chapters.
To access these functions, you must be logged in. On the login page you need to enter your email and password. If you want to stay logged in longer than two hours, you can check the 'remember me' checkbox. Otherwise you will automatically be logged out after two hours of inactivity.
After logging in, you can change the **language** by selecting your name in the top-right corner at the bottom of the menu.
The 'Logout' button is in the same menu.

> **Note for gamemasters and admins:** In the same drop-down menu as the languages, there is a function to **impersonate** other users.
> As a gamemaster you will only be able to impersonate players from companies in games you manage. As admin, you will be able to impersonate all registered users.
> To stop impersonating, go to the same menu.

To change anything regarding the user profile, like your username, email, and password, go to the same menu and select 'Profile'.

## Player Manual

### Decisions

As a player, your role is to make decisions in the game you have been assigned to. To get to the decisions overview, select Decisions on the navigation bar.

#### Make a decision

If no decision has been made in the current period, you will see a form to make decisions. For example, you can buy or sell different machines. To finalize your decision, you need to check the box on the bottom of the page. Now you can submit your decision. After that you will be redirected to the decision overview.
As of now, you cannot take back a decision that has been submitted.

#### View decisions from passed periods

If no decision has been made in the current period, you can view past decisions by using a button at the bottom of the page. If a decision has already been made, you will automatically be redirected to the overview.
On the overview page, there is a list of past periods. To check the details of the decisions in a specific period, you can click on 'Show'.

### Balance

The decisions you make have a direct influence on the outcome of your company. When the gamemaster continues to the next period, the results of the current period will be available. To view your results, click on the 'Results' page on the navigation bar.
There you will be presented with an income statement and a balance sheet of the current period. You can once again view details of a different past period in the same way as before.

## Gamemaster Manual

As a gamemaster, your functions are specialized to managing games. As a gamemaster you own games and can manage the games that belong to you. After the initial creation of a game, multiple gamemasters can be assigned to a single game.
When you submit a false value or certain names are already taken in your game, a message will appear on top of the form further detailing the error. No new object of any kind will be created, only if you change the incorrect value.

### Games

Under the 'Create Game' tab in the navigation bar you can create, edit, and delete games. When editing, you can also change their status. Available statuses are pending, active, completed, and canceled.
If you want to manage companies etc. in another game, you can select the desired game under the 'Select a Game' tab. If a game name is already taken, the system will let you know.

### Companies

To build the foundations of your game companies are necessary so players can participate in the game. The tab 'Companies' redirects you to a page to create, edit, and delete companies. Company names are unique to a game. That means one company in one game always has a name no other company in that game has. Two companies in different games can share a name.

### Players

To manage a certain player, the user needs to be registered with a player role and a company needs to exist in the desired game. Under the 'Assign Player' tab you can create, edit, and delete players. This means assigning an already existing player to a company.

### Machine types

Under the tab 'Machinetypes' you are able to manage machine types. Machine types are the types of machines a company can purchase in the game. You can manage important characteristics. Once again, the names must be unique within a specific game.
You can manage these parameters: name, price, fixed cost per period, capacity, number of operators, and depreciation period. In capacity, you specify the number of units one machine can produce per period and the number of operators is the number of workers who can work on one machine at a time. Depreciation period defines the number of periods a machine can be used.

### Decisions from players

In the 'Decisions' tab, you can see the decisions that companies have (or have not) submitted for the current period. You can see details about who submitted which decision and when. There, you can also confirm all decisions made and continue the game to the next period.

## Admin Manual

As an admin, you are responsible for the user management. If required you can impersonate any gamemaster or player, to ensure the games run smoothly.

### Users

Under the 'Users' tab you can create, edit or delete a user. When editing a gamemaster you have an option to add the user to an already existing game to manage that game.
In case of creating a user with an email that is already taken, the system will let you know through an error message on top of the page.