= Open Game Finder
:author:
:revnumber:
:revdate: 2016/03/17 20:48
:keywords: network
:relfileprefix: ../../
:imagesdir: ../..
ifdef::env-github,env-browser[:outfilesuffix: .adoc]


The Open Game Finder (OGF) by Mark Schrijver can be plugged into any Java game. OGF enables you to find other people playing the same multiplayer game, and join them.

*  Homepage: link:https://code.google.com/archive/p/open-game-finder/[https://code.google.com/archive/p/open-game-finder/]
*  Documentation: link:https://code.google.com/archive/p/open-game-finder/w/list[https://code.google.com/archive/p/open-game-finder/w/list]

Both on the client and the server side of OGF is written purely in Java. OGF has a pluggable architecture and comes with a full set of plugins to get the job done. You can add your own plugins, or replace existing plugins to make them more in line with your game. OGF uses NiftyGUI as the main +++<abbr title="Graphical User Interface">GUI</abbr>+++ plugin.


== Installation

.  Go to link:https://code.google.com/archive/p/open-game-finder/downloads/list[https://code.google.com/archive/p/open-game-finder/downloads/list]
.  Download Client-1.0-bin.zip and Server-1.0-bin.zip
.  Unzip the two files to, for example, your jMonkeyProjects directory.


== Setting up the Database

The OGF server uses an embedded Apache Derby database. You have to install the database, this means creating the data files and adding the tables. You can do this straight from the command line by running a script file.

*  On Windows, use installServer.bat to create a new database from scratch. On Mac +++<abbr title="Operating System">OS</abbr>+++ or Linux, run `java -jar lib/Server-0.1.jar install` in the Terminal.
*  On Windows, use updateServer.bat to update the difference between the current state of the database and the way it should be. On Mac +++<abbr title="Operating System">OS</abbr>+++ and Linux, run `java -jar lib/Server-0.1.jar update` in the Terminal. +*This new feature is currently untested.*


== Running the server

Change into the OGF-Server directory and run the server:

*  On Windows: Run startServer.bat
*  On Linux and MacOS X: Run `java -jar lib/Server-1.0.jar` in the Terminal.

The server is now running and ready to accept connections. +
*Note:* In the alpha release, the server runs on localhost. In the final release, you will be able to configure the host!


== Running the client

.  Change into the OGF-Client directory and run the client:
**  On Windows: Run startClient.bat
**  On Linux and MacOS X: Run `java -jar lib/Client-1.0.jar` in the Terminal.

.  If a Display Settings window appears, you can keep the defaults and click OK.

A client is now running, connects to the server, and displays a registration/login window.

image::jme3/advanced/open-game-finder-1.png[open-game-finder-1.png,width="",height="",align="center"]

*Note:* You can run several clients on localhost for testing.


=== Client: 1. Registration

If clients use OGF for the first time, they need to register.
On the main screen of the client:

.  Click Register
.  Choose a user name and password (repeat the password).
.  Select an Avatar image.
.  Click register to complete the registration.

The client registers the account and opens the chat window directly.


=== Client: 2. Login

If returning clients are already registered to an OGF server, they can log in.
On the main screen of the client:

.  Enter a user name and password that you previously registered.
.  Click Login

The client logs you in and opens the chat window.


=== Client: 3. Chat

The chat window shows a list of all users logged in to the server. Logged-in users can send public messages, and can receive public messages from others.


== Connecting to a Game

Q: I want to gather players using the OGF client to connect to the game server. How do I start my multiplayer game? +
A: The following sample code demos the typical use case: link:https://code.google.com/archive/p/open-game-finder/source/browse/OGF/TRUNK/Client/src/main/java/com/ractoc/opengamefinder/client/OGFClientStartup.java[OGFClientStartup.java]
+
In a JME3 Application's init method:

.  Create a com.ractoc.opengamefinder.client.GUIContainer object.
.  Create a game instance using the GUIContainer (via a ClientFactory).
.  Check the com.ractoc.pffj.api.BasePluginMessageResult for success or failure.

After this, continue writing your JME3 init method.


== Configuration

*  Q: How can I offer more avatars to choose from? +A: Save the image files in the path `jMonkeyProjects/OGF-Client-1.0-bin/OGF/resources/avatars/`
*  Q: How do I configure servers addresses? +A: TBD