Download as pdf or txt
Download as pdf or txt
You are on page 1of 18

Introducing MiniGames

Distribution: Mini- and NanoGame Operators


Version: 2.00
Document Number: 007-756

7 June 2016
Contents

INTRODUCTION ................................................................................................................................... 3
FEATURES .......................................................................................................................................... 4
ARCHITECTURE .................................................................................................................................. 5
SERVER.......................................................................................................................................... 5
CLIENT ........................................................................................................................................... 6
REGULATED MARKET REQUIREMENTS ................................................................................................ 6
INTEGRATION...................................................................................................................................... 7
COMPATIBILITY ............................................................................................................................... 7
HOSTING ........................................................................................................................................ 7
APPLICATION PROGRAMMING INTERFACE COMPONENTS ................................................................... 12
HOST ........................................................................................................................................... 12
XPROX ......................................................................................................................................... 13
ONJSCALLBACK FOR XPROX ..................................................................................................... 13
MINISYS ....................................................................................................................................... 14
ONJSCALLBACK FOR MINISYS ................................................................................................... 14

CODE LISTS ..................................................................................................................................... 16


GAME IDS..................................................................................................................................... 16
LANGUAGE CODES........................................................................................................................ 17
USER TYPES................................................................................................................................. 17
LOGIN CONFIGURATION .................................................................................................................... 18

Figures

FIGURE 1 - MINIGAME MAIN AND OPTIONS SCREENS ............................................................................3


FIGURE 2 - MINIGAME PAYTABLE SCREENS .........................................................................................3
FIGURE 3 - SERVER ARCHITECTURE .....................................................................................................5
FIGURE 4 - CLIENT ARCHITECTURE ......................................................................................................6
FIGURE 5 - HOSTING PROCESS ............................................................................................................7

Version: 2.00 Page | 2 of 18


Introduction

This document provides an overview of our MiniGames product offering.

MiniGames are simpler, smaller, standalone versions of existing casino games. The games are
designed to occupy a considerably smaller area without branding and peripheral functionality.

Figure 1 - MiniGame Main and Options Screens

Figure 2 - MiniGame Paytable Screens

Version: 2.00 Page | 3 of 18


Features

The features available for MiniGames are:

• MiniGames can be hosted on any Flash 8 compatible hosting programme.

• You have full control over the launching of the game. You can launch games in areas that
have never supported rich playable game content before.

• You are not limited by standard feature sets, such as lobbies and conversion hooks.

• You can design and control the real-estate surrounding the game.

• MiniGames have SGI capability and support the passing of an authentication code from an
external system, such as Orbis.

• MiniGames include multi-window support, so players can play up to three games


simultaneously.

Note:
• The multi-window functionality is not included in the Bingo client, as it is designed to
support only one MiniGame.
• You can choose to support more than three simultaneous games. However, this can
introduce performance and game play issues.

• The code to call games is optimised by reusing open game files instead of reloading them
each time they are required.

• Session Reminders are available to meet United Kingdom Regulated Market requirements.

To order MiniGames, please contact your Service Manager.

Version: 2.00 Page | 4 of 18


Architecture

This section outlines the MiniGame system architecture

Server

The Flash Casino client and the Flash MiniGame client both connect to the same Gaming System.
However, the Flash MiniGame content is hosted on a different site on the Web Server.

Figure 3 - Server Architecture

Version: 2.00 Page | 5 of 18


Client

The MiniGame client comprises:

• The MiniGame containing the game logic.


• The MiniSystem, known as MiniSys, providing the underlying functionality required for the
game. There is one MiniSys per MiniGame.
• The Communications Layer, known as XProx, handling Client-to-Client and Client-to-
Server communication. One communications layer is shared by all instances of the
MiniSys.

Mini Game 1 Mini System 1

Communication
Internet

Mini Game 2 Mini System 2 Layer


(XProx)

Gaming Server Database Server

Mini Game 3 Mini System 3

Figure 4 - Client Architecture

Regulated Market Requirements

MiniGames support session reminders to meet United Kingdom regulatory requirements.

The reminder times are driven by a logical session API.


Example URL: https://api{n}.gameassists.co.uk/Account/responsiblegaming/public/v1

The MiniGames system maintains all session reminder states, except deleting the session.
Session deletion must be done when handling the EXIT_GAME command in the implementation of
the following:

function onSWFcallback(command, args)

For more information on session reminders for the United Kingdom Regulated Market, please
contact your Service Manager.

Version: 2.00 Page | 6 of 18


Integration

This section outlines the requirements for integrating MiniGames.

Compatibility

You can host MiniGames in any Flash 8 compatible hosting programme, such as Internet Explorer,
FireFox and custom programmes. To promote this hosting flexibility, fraud control is not
supported.

Hosting

The process to follow for hosting a MiniGame is illustrated below and described in detail in the
table.

MiniGames are designed to enable players to play multiple games simultaneously, using the same
account. The player account balance is updated and sent to each MiniGame at regular intervals to
keep all clients synchronised.

If you want to offer a suite of games, you must follow steps 1 to 4 as described in the table to
follow, and repeat steps 5 and 6 for each game that you require.

Note:
You must pass the same XProx local connection ID for each game.

Figure 5 - Hosting Process

Version: 2.00 Page | 7 of 18


MiniGames Hosting Process

Step Description Comments Sample Code

1 Load The XProx.swf contains the Hosting in a .swf:


xPrx.swf communication layer logic and http://webserver1.bluemesa.mgsops.net/flash/minigames/xprox.swf?swfho
exposes functionality required sting=1
by the Mini Sys. If you are
hosting XProx within another
*.swf file, you must post the Hosting elsewhere:
swf hosting parameter with a http://webserver1.bluemesa.mgsops.net/flash/minigames/xprox.swf
value of 1.

2 Initialise the XProx variables are initialized Example 1: Setting multiple variables at once:
XPrx using the XProx
var values:Object = new Object();
variables onJScallback() method.
values.sEXT1 = this._sEXT1;
To initialize all variables at values.sEXT2 = this._sEXT2;
once, create an object and values.CasinoID = this._CasinoID;
assign the required values to values.xmanURL = this._xmanURL;
it. You can then pass this
object into the onJScallback() values.clientLanguage = this._clientLanguage;
method, as shown in Example values.platformID = this._platformID;
1. values.sessionId = null;
values.enableSessionReminders = 1; //(UK Regulated Market only)
You can also initialize one
variable at a time. You must values.siteID = 2; //(UK Regulated Market only)
call the onJScallback()
method again to specify that this._xproxHolder.onJScallback("SETVARIABLE","ALLVARIABLES",values);
you are finished setting
variables, as shown in
Example 2: Setting variables individually:
Example 2.
// set the variable sEXT1
For a complete list of this._xproxHolder.onJScallback("SETVARIABLE", "sEXT1", this._sEXT1);
variables, see the XProx // signal the end of variable initialization

Version: 2.00 Page | 8 of 18


Step Description Comments Sample Code
section.
this._xproxHolder.onJScallback("MINIRUBY_COMPLETE_GETDETAILS");

3 Get the local XProx calls the


connection onSWFcallback() method with
ID the XPROX_LCID command.

Note:
The host is expected to
publish access to the
onSWFcallback() method and
is responsible for handling the
calls made to this method.

4 Wait for the XProx automatically logs


login to players on once the variables
complete are set.

If a session ID is passed into


XProx, it does not attempt to
log the player on.
If the login is successful,
XProx calls back the
onSWFcallback() method with
the LOGIN_COMPLETE
command.

Note:
The host is expected to
publish access to the
onSWFcallback() method and
is responsible for handling the
calls made to this method.

Version: 2.00 Page | 9 of 18


Step Description Comments Sample Code

5 Load The minisys.swf contains the Hosting in a .swf:


minisys.swf system logic required by the
http://webserver1.bluemesa.mgsops.net/flash/minigames/system/minisys.
MiniGame.
swf?swfhosting=1
If you are hosting MiniSys in
Hosting elsewhere:
another *.swf file, you must
post the swf hosting parameter http://webserver1.bluemesa.mgsops.net/flash/minigames/system/minisys.
with a value of 1. swf

6 Initialise the MiniSys variables are Example 1 - Setting multiple variables at once:
MiniSys initialized using the MiniSys
var values:Object = new Object();
variables onJScallback() method.
values.sEXT1 = this._sEXT1;
To initialize all variables at values.sEXT2 = this._sEXT2;
once, create an object and values.CasinoID = this._CasinoID;
assign the required values to values.xmanURL = this._xmanURL;
it. You can then pass this
object into the onJScallback() values.clientLanguage = this._clientLanguage;
method, as shown in Example values.platformID = this._platformID;
1. values.sessionId = null;
values.userType = this._userType;
You can also initialize one
variable at a time. You must values.gameID = this._currentgame;
call the onJScallback() values.lcid = this._lcid;
method again to specify that values.enableSessionReminders = 1; //(UK Regulated Market only)
you are finished setting values.siteID = 2; //(UK Regulated Market only)
variables, as shown in
Example 2.
this._minisysHolder.onJScallback("SETVARIABLE","ALLVARIABLES",values);
For a complete list of
variables, see the MiniSys Example 2 - Setting variables individually:
section.
// set the variable sEXT1
this._minisysHolder.onJScallback("SETVARIABLE", "sEXT1", this._sEXT1);

Version: 2.00 Page | 10 of 18


Step Description Comments Sample Code
// signal the initializing variables
this._minisysHolder.onJScallback("MINIRUBY_COMPLETE_GETDETAILS");

7 Load the The MiniSys now automatically


game loads the MiniGame specified
by the gameID variable. For
more information, see the
Game IDs section.

8 Close the If the MiniGame is embedded this._minisysHolder.flushSys()


MiniGame in the host Flash Player, you
must call the flushSys()
method on the MiniSys object
to enable clean up. If the
method is not called, you
cannot load a different game.

If the MiniGame is launched in


a separate window, no clean-
up is required.

Version: 2.00 Page | 11 of 18


Application Programming Interface Components

This section lists the components required for the Application Programming Interface (API).

Host

The XProx and MiniSys components use the onSWFcallback method to pass information back to
the host.

Note:
The host is expected to publish access to the onSWFcallback() method and is also responsible for
handling the calls made to this method.

Parameter Type Values Permitted Applies To Comment

Command String MINIRUBY_START XProx, MiniSys Indicates that MiniSys / XProx is


_GETDETAILS ready to start receiving variables.
XPOX_LCID XProx XProx is in the process of
initializing and is returning its local
connection ID to pass to the
MiniSys.
LOGIN_COMPLET XProx XProx has attempted a login and
E received a response. This can
include failed logins.
HANDLE_ERROR MiniSys MiniSys has encountered an error
and is notifying the host to take the
necessary steps. No error code is
provided in this callback.
EXIT_GAME XProx A session reminder has been
displayed and the user has clicked
‘exit’. All open games should be
closed and a REST call made to
delete the logical session.
Args Object <Value(s)> XProx, MiniSys An object containing value/s
associated with the command. The
values that are returned, include:
• XPROX_LCID - returns the
local connection ID only.
• LOGIN_COMPLETE returns
an object with Successful
Login -true/false, Player
balance, Session ID and User
Type - refer to the User Types
section.

Version: 2.00 Page | 12 of 18


XProx

The XProx parameters are:

Parameter Data Type Description

sEXT1 - The player’s username. This is not mandatory.


sEXT2 - The player’s password. This is not mandatory.
casinoID - The server ID.
XManUrl - The URL of the X-Man server.
casinoUL - The language code specifying the language to use.
For more information, refer to the Language Codes
section.
xsession - A current, valid X-Man session. This is not
mandatory.
token - The token used for authentication against an
external database, instead of a username and
password.
enableSessionRem Integer. 1 = on, Used to turn session reminders on or off. This is
inders 0 = off for the United Kingdom Regulated Market only.
siteID String The logical session API site ID. This is not
mandatory.

onJScallback for XProx

onJScallback is used by the host to pass information to the XProx component.

Parameter Type Values Permitted Description

Command String SETVARIABLE Use this command when setting variables within
XProx. This is used to set all variables at once or
individually.
MINIRUBY_COMPL If you set variables individually, you must send this
ETE_GETDETAILS command to indicate that you are finished.
Name String ALL VARIABLES Set the Name parameter to ALLVARIABLES when
setting all the XProx variables at once.
<Variable Name> Set the Name parameter to the variable name to
set a specific variable.
Value Object <Values(s)> Values to set the variable(s) to.

Version: 2.00 Page | 13 of 18


MiniSys

The MiniSys parameters are:

Parameter Data Type Description

sEXT1 - The player’s username. This is not mandatory.


sEXT2 - The player’s password. This is not mandatory.
casinoID - The server ID.
XManUrl - The URL of the X-Man server.
casinoUL - The language code specifying the language to use.
For more information, refer to the Language Codes
section.
xsession - A current, valid X-Man session. This is not
mandatory.
token - The token used for authentication against an
external database, instead of a username and
password.
usertype - The type of player account. This is not mandatory.
For more information, refer to the User Types
section.
gameid - The ID of the MiniGame that you want to load. For
more information, refer to the Game IDs section.
lcid - The local connection ID, supplied by XProx.
enableSessionRem Integer. 1 = on, Used to turn session reminders on or off. This is
inders 0 = off for the United Kingdom Regulated Market only.
siteID String The logical session API site ID. This is not
mandatory.

onJScallback for MiniSys

onJScallback is used by the host to pass information to the MiniSys component.

Parameter Type Values Permitted Description

Command String SETVARIABLE Use this command when setting variables within
MiniSys. This is used to set all variables at once or
individually.
MINIRUBY_COMPL If you set variables individually, you must send this
ETE_GETDETAILS command to indicate that you are finished.
Name String ALL VARIABLES Set the Name parameter to ALLVARIABLES when
setting all the MiniSys variables at once.

Version: 2.00 Page | 14 of 18


Parameter Type Values Permitted Description

<Variable Name> Set the Name parameter to the variable name to


set a specific variable.
Value Object <Values(s)> Values to set the variable(s) to.

Version: 2.00 Page | 15 of 18


Code Lists

Game IDs

The game IDs are:

GameName GameType ModuleID ClientID ServerGameID

Couch Potato Classic Slot 10024 16001 MiniCouchPotato


Cool Buck Classic Slot 10000 16000 MiniCoolBuck
Break da Bank Classic Slot 10001 16000 MiniBreakDaBank
Spectacular Bonus Slot 12514 16000 MiniSpectacularWheelofWealth
Wheel of Wealth
Triple Magic Classic Slot 10030 16000 MiniTripleMagic
Bulls Eye Classic Slot 12510 16000 MiniBullsEye
Legacy Classic Slot 10001 16001 MiniLegacy
Tomb Raider Bonus Slot 12506 16000 MiniTombRaider
Mermaids Bonus Slot 12506 16001 MiniMermaidMillions
Millions
European Table Game 134 16000 MiniEuroBlackjackGold
Blackjack Gold
Loaded Bonus Slot 12528 16000 MiniLoaded
Mega Moolah Bonus Slot 17501 16000 MiniMegaMoolah
Avalon Feature Slot 10044 16000 MiniAvalon
Hitman Bonus Slot 12547 16000 MiniHitman
Spring Break Feature Slot 10025 16002 MiniSpringBreak
The Osbournes Video Slot 12561 16000 MiniTheOsbournes
Bush Telegraph Bonus Slot 12518 16000 MiniBushTelegraph
Carnaval Video Slot 10020 16000 MiniCarnaval
Ladies Nite Feature Slot 10025 16001 MiniLadiesNite
Mad Hatters Bonus Slot 12532 16000 MiniMadHatters
Tally Ho Feature Slot 10038 16000 MiniTallyHo
Thunderstruck Feature Slot 10025 16000 MiniThunderstruck

Version: 2.00 Page | 16 of 18


Language Codes

The language codes are:

Code Description

en English

Note:
MiniGames are currently only available in English, but are designed to support multiple languages.
This is to minimise future development.

User Types

The user types are:

Code Description

0 Real
5 Demo

Version: 2.00 Page | 17 of 18


Login Configuration

There are two main login options that are configurable:

• Fallback
This login option specifies what action the system must take when there is no valid player
session. The options are:

- Auto Login
The system automatically attempts to log players on using any available login details.
The Login screen is not displayed to players.
- Login
The Login screen is displayed to players without populated fields. Players must
complete all their login details.
- Populated Login
The Login screen id displayed to players with their username entered, if available.
Players can change the pre-populated details.

• Failed Login
This login option specifies what action the system must take when a login attempt fails.
The options are:

- Error with Login


The system proceeds to the selected fallback login option when a login error occurs.
- Error No Login
The system does not permit players to log on after a login error occurs. This is used
when the player login details were passed to the MiniSystem and the player does not
know what the login details are. It is recommended that this option is used for SGI, or
any other custom login solutions.

The recommended login settings for each login solution are:

Login Solution Fallback Option Failed Login Option

SGI Auto Login Error no Login


One-Click Populated Login Error with Login
Bingo Populated Login Error No Login

Note:
Please specify your configuration preferences when ordering your MiniGames, and we will set
these up.

Version: 2.00 Page | 18 of 18

You might also like