Anwender- Dokumentation

Transcription

1 Anwender- Dokumentation Onlinespieleportal Reversi Gruppe 23 Projekt Softwaretechnik WS 2008/09 Uni Rostock Christian Eichner Nils Faupel Stefan Gladisch Martin Nyolt Cornelius Radicke Jonas Vetterick

2 Table of contents 1 Reversi Client User Guide Rules of Reversi Window Description How to register How to change your profile Creating a game Creating a tournament Managing a group Joining a group Ranking Error messages Reversi Server User Guide Quick Overview How to set up the server...11

3 1 Reversi Client User Guide 1.1 Rules of Reversi Reversi is a game for two players, red and black. Red makes the first move. Set an new stone of your color on a free field to make your move. There have to exists at least one straight (horizontal, vertical, or diagonal) occupied line between the new stone and another of your stones, with one or more contiguous stones of your opponent between them. After placing the new stone all stones of your opponent on this lines change there color to yours. All possible fields are marked. Every stone counts one point. The game ends, when all fields have a stone on them, or both players are not able to make a move. The player, who has more points at the end of the game wins. If there are free fields, each of them counts one point to the winner. A player loses if he leaves a game before the game is over. A player loses if he doesn't make his move within the maximal move time of the game. Uni Rostock WS 08/09 3/11

4 1.2 Window Description Lobby Window Uni Rostock WS 08/09 4/11

5 Game Window 1.3 How to register To create an account, follow these steps: Click on "Account" > "Register" Fill in your nickname, password (twice) and address Click on "Register" Now the 'Register' dialog should disappear and some messages in the lobby acknowledge that you are registered and logged in. If you are having any trouble, please check the following: You are connected to a server Your nickname is at least 3 characters long Your password is at least 6 characters long Uni Rostock WS 08/09 5/11

6 The following characters are allowed a..za..z!" $%&/()=?[] Your has a valid format 1.4 How to change your profile To change your profile, it is necessary to be logged in. Click on "Account" > "Profile". In the profile window, which is now shown to the user, you can see and change your profile information. Your player description and also your statistics are visible for other players. 1.5 Creating a game To create a game you have to be logged in. Click on "Game" > "Create Game". You can choose between "Public" and "Group" Public: Everyone is able to join your game Group: Just members of your own group are able to join your game It is either possible to enter a maximum move time which must be between 10 and 999 seconds, or to enter 0 seconds for unlimited move time. Click "create!" to open the game. Wait for an opponent. 1.6 Creating a tournament To create a tournament you have to be logged in. Click on "Game" > "Create Tournament" You can choose between "Public" and "Group" and "GvG" Public: Everyone is able to join the tournament Group: Just members of your own group are able to join the tournament GvG: Means Group vs. Group. The menbers of your group play against the members of another group. To configure your tournament follow those steps: Enter a name for the Tournament. Enter the maximum of players for this Tournament. Enter a date where the Tournament will be started. Enter a time in secounds for every move. (optional) choose a opponent group. Uni Rostock WS 08/09 6/11

7 Click "Create!" to open the Tournament. 1.7 Managing a group The group information and settings can be shown by clicking on "Group" > "Show Group". The manage-group-window contains a list of all group members, the group description, name and the groups statistics. The group statistics are only affected by games of Group vs. Group tournaments. The group status can either be "restricted" or "public" which is shown on the top left corner of the window. "restricted" : the admin has to authorize every new member candidate before he becomes a full member of the group. "public" : every player is able to join the group without admin's authorization. If you are the admin of the group you are allowed to change those settings and moreover to authorize, kick and to name a new admin. 1.8 Joining a group To join a group you have to be logged in. It is not possible to be a member of more than one group. If you want to change your group you have to leave your current group. Afterwards you are able to create or join a new group. To join Group click on "Group" > "Create Group" Choose the name of the Group you want to join and click "Join". Some groups are restricted, so maybe you have to wait for authorization before you become a member of the group. 1.9 Ranking There are two types of statistics player and group statistics. Click on "Ranking" > "Players" to get the current player ranking Click on "Ranking" > "Groups" to get the current group ranking Uni Rostock WS 08/09 7/11

8 1.10 Error messages Connection to server lost The client lost the connection to the server. If you are still connected to the internet, the server probably went offline. Try to connect again to the server. If you could not connect, try later or choose another server. Could not connect to Server The client could not connect to the server. Please make sure: You are connected to the internet You entered the right address and the server is reachable Your firewall doesn't block the server port (usually 31337) or the client application Could not change the name This message means that you could not change your name. You have probably chosen a name which is already used by someone else. So please choose another name and try again. Could not create the group This means that the group you wanted to create already exists. So please choose another name for your group, which is not already used. To see a list of all groups choose "Join Group" in the lobby window. Could not join the group This message means that you could not join the group. Most probably the group was deleted right before you wanted to join it. So just try again to join the group, if it's still in the list. If this doesn't help you might want to create your own group. Error deleting profile This message appears if you wanted to delete your account, but either entered a wrong password, or the player you wanted to delete does not exists. So please make sure: Uni Rostock WS 08/09 8/11

9 You have an account on the server you are connected to Your name and password are spelled correctly Error logging in This message appears when you could not log in. You either misspelled your name and/or password or you are not registered. Please remember you can register on different servers, and each server has its own user database. So please make sure: You already have an account on the server you are connected to Your name and password are spelled correctly Error registering This message means that you could not register. Most likely this is because the name you have chosen is already registered. So just try another one. If this problem persists, then there is a problem with the server. Please contact your server's administrator. Incompatible version Your client version is not compatible with the servers one. You can see your version in the title bar of the lobby window. You should download the latest version. If this problem persists, contact your server administrator and ask for an appropriate version. Uni Rostock WS 08/09 9/11

10 2 Reversi Server User Guide 2.1 Quick Overview Current server status 2 Button to start/stop the server 3 Settings 4 Logged-in users Uni Rostock WS 08/09 10/11

11 2.2 How to set up the server Prerequisites Before you can start configuring your Reversi server, you first have to set up a MySQL database. You can download it from there is also a documentation on how to set it up. We recommand you to install MySQL on the same machine as the Reversi server. Once MySQL is installed, you have to create a new, empty database with a name you like. Configuration You can change the server settings on the right-hand side of the window. The most important things to configure are the settings for the database. MySQL-Address: The IP or domain of the MySQL-Server. Most likely you enter localhost or here. MySQL-Port: The port on wich the MySQL-Server listens. This is typically MySQL-User and MySQL-Password: Enter here a MySQL-user name and it's password with access to the database MySQL-DB: The database you created before. Server-Port: Enter here the Port on wich the Reversi-Server should listen for clients. The default is Remember that if you change the port, you have to tell it to your users. You can now start the server by clicking on "Start Server". If this is the first time the server is starting, it automatically creates it's tables in the database. Uni Rostock WS 08/09 11/11