Skip to content
Score and achievement API to allow HTML5 game developers to submit scores, medals and achievements to WordPress Arcade sites powered by MyArcadePlugin.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE
assets/images Added MyArcadePlugin logos for promotional use to the assets/images f… Oct 13, 2019
LICENSE Create LICENSE Oct 16, 2019
README.md
changelog.txt Added MyArcadePlugin logos for promotional use to the assets/images f… Oct 13, 2019
myarcadebridge.js Initial release Oct 12, 2019
myarcadebridge.min.js

README.md

MyArcadeScoreBridge

Score and achievement API to allow HTML5 game developers to submit scores, medals, and achievements to WordPress Arcade sites powered by MyArcadePlugin.

This API will allow site owners to collect scores, generate leader boards and run contests. Additionally, it will help game developers to promote their games and make them more popular.

How to use MyArcadeScoreBridge in your HTML5 / JS games?

There are only two simple steps to follow in order to make your game score and leader board ready.

Step 1

Import 'myarcadebridge.js' into your game. You can do this in two ways:

Option 1

Import the JavaScript file directly in your index.html.

<script src="myarcadebridge.js"></script>

Option 2

Additionally, you could load the file dynamically.

var js = document.createElement('script');
js.type = 'text/javascript';
js.src = 'myarcadebridge.js';
document.body.appendChild(js);

Step 2

Now, you are ready to submit scores and achievements to user sites. The bridge offers you the functions myarcade_submit_score and myarcade_submit_achievement.

Submitting scores

Many games submit achieved scores on game over but some of them offer a button to submit scores. You can use any method you like in your game. Just make sure that the scores are submitted only once.

To submit scores just call myarcade_submit_score and pass the achieved score to the function.

myarcade_submit_score( score );

Submitting medals or achievements

In some games users are able to gain medals or achievements while playing. With MyArcadeScoreBridge you can submit achievements at any during the game play. Therefor use the function myarcade_submit_achievement.

In order to submit a medal or achievement you will need to create an achievement object. The object should contain following fields:

  • title: Achievement/Medal title
  • description: A detailed description of this achievement
  • score: Score associated with this achievement
  • icon: An URL to a badge, trophy for this achievement
Example
var achievement = {
 title: "Your achievement title",
 description: "Achievement description.",
 score: score,
 icon: "https://site.com/trophy.png"
};

myarcade_submit_achievement( achievement );

How to tell users that your game is compatible with MyArcadePlugin?

In the assets/images folder, you'll find two MyArcadePlugin logos which you can embed in your games.

You can’t perform that action at this time.