# ArchbotGUI Module

ArchbotGUI module creates a communication channel between game client and [Generic Test Suite](https://git.netent.com/projects/GAT/repos/archbot-generic-testsuite-opr/browse).
Game based data which is required by Generic Test Suite or any Automated test cases can be obtained from game by using
 this module. 

## Usage

**Step 1**: add archbotGUI module in game client package.json

```bash
npm i -E @netent/archbot-testsuite-guimodule@x.x.x
```

and following entries to the index.xhtml:
```bash
<script src="../node_modules/@netent/archbot-testsuite-guimodule/core/archbotGUI/ArchbotGUI.js" type="text/javascript"></script>
<script src="../node_modules/@netent/archbot-testsuite-guimodule/core/archbotGUI/ArchbotGUIController.js" type="text/javascript"></script>
<script src="../node_modules/@netent/archbot-testsuite-guimodule/core/archbotGUI/ArchbotGUIModel.js" type="text/javascript"></script>
<script data-type="init" src="../node_modules/@netent/archbot-testsuite-guimodule/archbotOverrides/core/Controller.js" type="text/javascript" ></script>
<script data-type="init" src="../node_modules/@netent/archbot-testsuite-guimodule/archbotOverrides/core/View.js" type="text/javascript" ></script>
```

**Step 2**: Check ArchbotGUIController js file. There is DATA_SET object which you must override according 
to your game. Ex:

```bash
"background": {
    "backgroundItem": {pixi: "abc", nonPixi: "item"},
    "maingameReelContainer": {pixi: "reelsArea", nonPixi: "itemReelArea"}
},
```

If we want to fetch the continue button of the "featureSplash" module.
Then you just need to put the property name under the game type ('pixi'/ 'nonPixi').
The property should be directly associated with the view.
in current case property name is 'featureSplashContinueBox' for continue button 
If property is not direct chile of view you may indicate the path with the dot operator,i.e.
If the 'featureSplashContinueBox' is under a property 'abc' which is direct child of view,
Then you may mention the key as 'abc.featureSplashContinueBox'.
you may use it for multiple levels too, i.e., abc.xyz.pqr.featureSplashContinueBox 

**Step 3**: Add following entry in modules.json in game client

```bash
"archbotGUI": {
    "module": "Archbot.ArchbotGUI"
}
```

**Step 4**: Go to [Starburst repo](https://git.netent.com/projects/GRXIJ/repos/starburst-client-generic/browse?at=refs%2Fheads%2Fmaster)
go inside "src/config" and copy "archbotTestData.json" to your game client's "src/config" folder. Change 
"archbotTestData.json" according to your game data. For example: If your game have Intro movie and Feature Splash (Intro screen) then set these properties to true.

```bash
"hasIntroMovie" : false,
"hasIntroScreen" : true,
```
**Step 5**: put archbotTestData.json entry in resources.xml of game client

```bash
<resource>
    <url>config/archbotTestData.json</url>
    <type>json</type>
    <name>archbotTestData</name>
    <size>4822</size>
</resource>
```
**Step 6**: Now check game client build process. New added module / files must come in build version of game

## Issue tracking

Bugs and feature requests should be added to [JIRA](https://jira.netent.com/projects/ATCS/summary).

## Support

You can reach the development team on [Hipchat](https://hipchat.netent.com/chat/room/2048).