GameArter Basic SDK (HTML5)

You can use any tool for tracking you want. Do not you know any? Here's example of few of them.

By default, GameArter has implemented and supports Google Analytics for websites with a bridge of caching game-side data events. All you need to do to activate it, is to insert your own Google Analytics tracking id to "Basic settings" tab of your project. This analytics tracks all gameplayer-based data as players, source of visits, time of playing and so on. These data can be extended by data in a form of events sent from a game, see Google analytics guide page. Some basic events as scene change and so on can be send to analytics automatically on basis of analytics configuration.

GameArterSdk.I.AnalyticsEvent((string)action, (string)category, (string)label, (num)value);

/*
where:
category, label, value are optional parameters
See more at: https://developers.google.com/analytics/devguides/collection/analyticsjs/events
*/

Because of other services around a game, fullscreen mode must be called over GameArterSDK. Attach following call to fullscreen button in your game (if your game has such button). If a game is already in fullscreen mode, fullscreen is cancelled by the call.
GameArterSdk.I.Fullscreen();

• In-game brand

  SDK contains a multi-brand solution. In short, this feature allows to display all gameplayer logos on basis of a website the game is displayed on. Changes of outgoing links are also included. This feature is active for websites which promote games from GameArter system. With gameater promotion, there should be more gameplayes and higher incomes.

  If there is any brand logo in the game, it should be connected to this system as well. Logo to display you can get on address GameArterSdk.I.BrandLogo(); and redirect can be processed by calling GameArterSdk.I.OpenWebPage();

• Tracking redirects

  With our solution you will know about every made redirect. - From what logo, on what website, and how oftenly is being used.

  For tracking redirects, call GameArterSdk.I.OpenWebPage((string)targetUrl, (bool)sameWindow);

Every game contains many data-weight cutscenes, stories and animations which are displayed calmly only one time for the whole game. GSDK helps to reduce game filesizes by providing a story module — an option for downloading these stories from external storage only in a time when it’s required. Dynamic loading of game stories might be done via asset bundles or this SDK feature when the story is displayed in gameplayer above the game (like an ad).

• 1) Calling browser stories | GameArterSdk.I.RunCutScene ( animationNumber, function(state){} );

  Be sure that animation of such number is available for your game.

• 2) Callback functions

  There is a callback state - "not found","loaded", progress states and "completed".

• 3) Setting / switching of stories

  Is being made in "More" section of configuration of the project

  

GameArterSdk.I.RunCutScene(0, function(progress){
	switch(progress){
		case "loaded":
			// mute sounds, pause game
		break;
		case "completed":
			// unmute sounds, unpause game
		break;
		case "not found":
			// check that you have really devinned story with id 0
		break;
		default:
			console.log("current story progress is:",progress);
	}
});

GameArter SDK allows to installation of web games as Web Apps to user's device. Installation is possible to PC as well as mobile device.

Implementation

• NOTE: this feature is functional after submiting requests for publishing in GameArter.
• Icon of web app (displayed at user's screen of desktop / mobile) must be in .png format and in 2 dimensions - 192x192 & 512x512px. Name them "favicon-192.png" and "favicon-512.png" and attach to folder "_pwa". Upload this folder with other project files in "Files upload" section at GameArter panel.
• 1) External callback listener | GameArterSdk.I.AddExternalCbListener("PWAState", targetFunction);

  The listener is used for setting visibility of button "installing game as app". Design of the button is up to developer.

  copy

  
  GameArterSdk.I.AddExternalCbListener("PWAState", InstallAsAppButton);
  function InstallAsAppButton(state){
  	switch(state){
  		case "enabled":
  			// Display button
  		break;
  		case "disabled":
  			// hide button
  		break;
  	}
  }
  

  Button must be hidden in default.

• Next option, e.g. when a user comes to menu and there is not known state in the game →
  Get current state value | GameArterSdk.I.GetStatePWA()
  Returns "enabled" / "disabled". See point 1.
• 2) Request for instalation

  Request for adding game as app to user device is made by user's click at button "installing game as app". Returned state identifies about current state of installation. These states maz be sent to e.g. analytics for tracking click ratio.

  copy

  
  buttonAddAsApp.onclick = InstallGameAsApp;
  function InstallGameAsApp(){
  	GameArterSdk.I.InstallAsPWA(function(state){
  		switch(state){
  			case "rejected":
  				// request is rejected. Be sure the request is posted only if GameArterSdk.I.GetStatePWA() === "enabled".
  			break;
  			case "dismissed":
  				// user cancelled the request
  			break;
  			case "accepted":
  				// user accepted the request
  			break;
  			case "installed":
  				// game was succesfully installed as app
  			break;
  		}
  	});
  }
  

  Visibility change of button during these states is driven via listener for "PWAState", see point 1.

Ready to use UI elements saving development time. In progress.

Start your game. During ad calls, your game should be paused, without mouse. During opened modules, the game should be in the settings you set. (Paused and muted by default). Calls to analytics are visible in the console. If everything is right, you can build the project and go to the next section.

Game files must be uploated to GameArter via "files upload" section (button available in project panel). Every project version has own place for its game files.

Mechanism for uploading files is build above Dropzone Open Source library.

Uploading files may be done by dropping files in your PC and moving them to DropZone area in GameArter

If your browser does not allow simple move & drop files mechanism, eventually the upload does not work as expected (e.g. inner folders are ignored), there is still possible to upload complete files inserted in .zip file.

New uploaded files automatically replaces files of the same filename. Cache is being cleared automatically during every file load.

Test the game button is available only if you are in a folder containing file index.html file (must be uploaded)

There is no possible to insert external links to body section. Load 3rd party links and libraries dynamically, if needed.

GameArter uses own-created GamePlayers designed purely for targeted platforms (a game runs in different gameplayer on every platform). For simple multi-player management, "files upload" section contain three textarea elements. Top area is designed for placing styles, middle area for placing game body elements, and the bottom for script elements. Once these text areas are filled, and this change saved, GameArter's gameplayers are created automatically on basis of data filled in text areas for style, body and script elements.

GameArter styles and javascripts are placed into gameplayer automatically. Do not place them manually, manual insertion is only for testing on localhost. GameArter libraries are placed at the top of footer element, so be sure that all scripts comminicating with GameArter SDK are placed in the footer element.

In a tab GamePlayer you can customize gameplayer. You can fill there game description, controls, links to social sites and so on.

Managed by "Publication" section of a project.

Before uploading your game to GameArter platform and processing release, be sure your intelectual property in a form of written game is being protected.

Currently, GameArter works on automatical obfuscation of uploaded source codes, meanwhile till this will be processed automatically you can do it for free yourself online.

Source code Obfuscation is good protection from stealing game code. To protect stealing the game and uploading it at other platforms, there is recommended to extend obfuscated files about simple domain check, e.g:

try{
	var allowedDomains = ["pacogames.com","gamearter.com"],
		host = document.location.href.split("/")[2].split("."),
		fullHost = host[host.length-2]+"."+host[host.length-1];
	if(allowedDomains.indexOf(fullHost) > -1){
		// run game
	} else {
	  	alert("Please, load the game from PacoGames.com");
  		document.getElementsByTagName("body")[0].innerHTML = "Unauthorized game start. Play the game on PacoGames";
    }
} catch(e){
	document.getElementsByTagName("body")[0].innerHTML = "Unauthorized game start. Play the game on PacoGames";
	alert("Some kind of problem occured. Please, let us know about the problem at [email protected]");
}

Once the game is ready to release, you can get a public link for free spreading in the "Publish" section of the project after pressing "Publish now button". In this case, game is automatically fully set and you can start share the game with players. In one working day since release, GameARter also will make additional check of the game and its functionality. Once the game is checked, you will be informed about result on Slack or email. If all is ok, the game will be sent to hundreds of webmasters in the system. Next day after release, the game will be displayed in reports sections of GameArter dashboard.

Important note: Once you press publish now button, the game passess from "testnet" to "release" state. In a case that your game is connected with GRT currency, any updates of events / items / packages will be visible in the game after confirmation from a side of administrators. This is a protection from manipulation with prices and affecting value of GRT token. Therefore be sure you are requesting release state when you are sure you will not update your released version of game. For testing next updates before release, you can use testnets where you can still edit all the items without any limitation.

Game updates are fully managed by developers via Publication tab in project environment. (Project section at GameArter). After pressing "Publish now" button, previous game version is instantly replaced for a new game version automatically. By this action, you take full responsibility for the update so be sure the new version works well.

GameArter keeps 2 last game versions for option to return back in a case of need.