First take the attachment file of the email we sent to you.

For version 8 there is ndll4.zip for OjyaLeaderboard4 extension and ndll5 for OjyaLeaderboard5 extension .

Then download the zip file  from the link in your email.

The zip file has: OjyaLeaderboard4 (Stencyl Extension version 7g), the new OjyaLeaderboard5 (Stencyl extension v8), Ojya Leaderb Game v8, AndroidManifest.xml file , PROJ-info.plist file, folder 'export v8', folder 'slimed NDLL for ios' compiled files for distribution and the PDF of the extension.

In your email there is also your password.

For the Ojyaleaderboard to test you need to create a Facebook App and have those 3 things:

1.   the AppID of your Facebook Testing App.

2.   ID Page Facebook, needed to post challenges in friend's timeline.

3.   Insert those values in the game.

First you need to create a Facebook application, as the facebook developer site will guide you, and also a test application, TestApp, of your application. Facebook site will guide you and it is very simple.

IMPORTANT: set your facebook app as a 'game' in the application category.

2. Now you need to have the ID Page Facebook.

For the ID Page Facebook , create a Facebook Page of your game.

You can fine this ID in your Facebook Page, section INFORMATIOM and in the bottom you can see the ID Page Facebook number.

This ID goes in the field "place" of  the extension block OjyaLB Post Challenge. (The ID Facebook Page works like a TAG-Place)

Last, create Virtual Facebook Test users and also make them friends together so you can test your game as in real life. Just Select ROLES in the left menu in your FacebookDev application site and select TEST-USERS on the top menu

3. Now Insert those value in the game.

Open the scene behavior FbAppPref and insert the following:

  a. Fb AppID

  b. Code we sent you via email and last your

  c. facebook page ID created before in the attribute 'G-ID FB Page for Challenge'

Leave the other information.

​

General demostration

New OjyaLB Post Challenge block version 2

Ojya Leaderboard Facebook Kit V5 Tutorial

Import Ojya Leaderboard game Kit in your game

Create the Leaderboard path

Version 9a - Multi type Sharing Items

Version 9b - Bonus Sharing Items saved in facebook server

Although we don't provide support for our game, cause it is ment to use it for helping other developers create their own leaderboard it can be used to understand the mechanism and also if you want modify ours.

By using this custom block at scene ojyaleaderboard/behavior Ojyaledaerboard/created Event

you post the score of that level , bonus and if the Action is 0, just replace the local and Facebook score with the new one.

If Action  is 1 keeps only the Highest score of that level in both local scores and Fb server scores.

If bonus is -1 updates only the score of that level and keep the previous bonus.

If you set this variable to TRUE uses the new OpenGraph Action Scores method.

If FALSE uses the original Facebook one score mechanism.

This is a guide for importing our sample leaderboard game ,that comes with the extension , in your existing game. For better understanding please use our game "OjyaLeaderboard v4-v5-v6" before doing this procedure.

Our game is in landscape mode and uses 2 scenes.

Please locate the folder "export".

Steps

1. Install our extension Ojyaleaderboard4 as described before to your existing game.

2. Copy to your "extras" folder of your game  the files inside our "Ojya Leaderboard v4" game extras folder.

3. Open your game and activate "OjyaLeaderboard4" extension. Close and reopen the game.

4. Create 11 Game Attributes with the EXACT names:

    a. fbuserid  (text)

    b. fbusername (text)

    c. xboxglobal (number)

    d. bonuslevel (number)

    e. draglevel  (number)

    f.  andylist2  (list)

    g. deleteuser  (boolean)

    h. leaderboard name  (text)

    i.  scenegame name  (text)

    j.  buttonfirst  (boolean)

    k. FBusercheckonce  (boolean)

5. Create an actor group in the settings menu, named "buttonsanchor".

IMPORTING ACTORS-SOUNDS-FONTS AND BEHAVIORS

6. Import the Actors in your game from our folder export. Those are png files

    NOTE: Importing the actors imports automatically also their behavior. If not, do it manually as explained bellow.

7. Locate the 5 actors with the below names and assign them to "buttonsanchor" group in properties.

    a. backtogame

    b. buttongetbonus

    c. buttonaskreqs

    d. buttonrequests

    e. levelframe

8. Import the fonts and the sounds

9. Create 2 scenes one named "Startgame" 1024x640 pix and the other named "leaderboard" 8064x1568 pix.

    Create also 5 tile layers for each scene above.

10. Import all the actor behaviors from our export folder in your game. The name start with "Act".

       example:  "Act actorinvisible" .  This is the behavior to assign for actor with name "actorinvisible"

11. Import the 3 scene behaviors , "FBloginStart" , "OjyaLeaderBoard" and "FbAppPref"(new version5e).

      There is also a "debugDraw" in version 6c.

ASSIGNING BEHAVIORS TO ACTORS(Usually not needed)  AND THE 2 SCENES

12. Assign to all the actors their respective behavior(Note:Read above importing actors)

      example: for actor "actorinvisible" the behavior "Act actorinvisible" , etc

      IMPORTANT: only for actor "actorinvisible" assign 2 behaviors. "Act actorinvisible" and

      "panningslave to img ActorInv"

13. Assign for the 2 scenes: Scene "Startgame" the behavior "FBloginStart" and for scene "leaderboard" the

      behavior "OjyaLeaderBoard" and "debugDraw" for version 6c

      Assign also the scene behavior 'FbAppPref' to both of the scenes ('Startgame" and "leaderboard" scene)

DONE !!!

After that open scene behavior "FBloginStart" , locate "defineAttributes" custom block and assign the fonts to the fonts Attributes matching the exact name.

example: font attribute "F-Loginuser" to font "Loginuser: imported from our export folder.

Then locate defineFacebook and insert all the information from your Facebook Application and your code.

Now locate the custom block "defineFacebook" and insert all the necessary information of your facebook App.

Note for Version 5e and v6 with scene behavior 'FbAppPref'.

To insert the facebook application information in your game you need to use only the behavior 'FbAppPref'.

No need to insert the info on the block 'defineFacebook' for each scene behavior as described above.

This 3rd new scene behavior has the facebook app information for both other scene behaviors.

Keep in mind that for API 2.8 and version v6 there is no need to create custom opengraph objects and acionsTypes. So the "G-Object ID" and "G-OG objectURL" attributes are obsolete.

To run the game you need to define 3 attributes (v6):

'Fb AppID' ,   'Code',   'G-ID FB Page for Challenge'.

Leave the others as they are defined.

(define before The  AndroidManifest.xml for Android and PROJ-info.plist in the 'INSTALL' section)

​

Important note:

Run first scene "Startgame" and after the scene "leaderboard" because the facebook user id has to be created first with login and this is in the scene "Startgame".

The scene "Startgame" has also the score attribute "xboxglobal" game attribute for using it with scene "leaderboard"

As you can see all the actors , scenes, sounds and the 11 game attributes are defined by the block with their exact names. With this way you only need to create actors, sounds and game attributes that match the name.

This is useful for importing to different games elements and avoiding having after blank blocks in stencyl.

This is a great feature in stencyl.

After that , and after you have inserted all the facebook information you can test the game.

If there are some graphic issues in designing the leaderboard, you can change some X Y coordinates and other attributes in the trigger behavior "drawbackground" in the scene behavior "OjyaLeaderBoard".

Please note that we don't provide support for the game imported. The game is for helping creating your own leaderboard.

Although, the game has great features like offline gaming and is studied as error proof and avoiding loosing information of scores and levels.

Ojyaleadrboard is ment only using our extension "Ojyaleadrboard2" with your games

Game Ojya Leaderboard

version 5 and above

Custom blocks and trigger events for the user to set the game .

Understand the 3 actions (POST, LEVEL, LEADERB)

Attributes to control drawing the background leaderboard map

Main Attributes to consider the user for setting the game v5:

“define attributes” CUSTOM BLOCK

leaderboard action (game attribute): The action (Post , Level, Leaderb. Explained above)

 draglevel (game attribute) : Its is the level of the game attribute

 xboxglobal  (game attribute): It is the score of a level attribute

 bonusLevel (attribute – ojyaleaderboard BEHAV.) : It is the bonus of the level

 attribute. (if -1 doesn’t update the bonus of that level)

 ActionPostScore (attribute – Ojyaleaderboard BEHAV.):  It is the condition to keep only

 the high score or overwrite score of a certain level (1 high score, 0 replace)

 noUserleaderb (attribute – Ojyaleaderboard BEHAV.):  It is the number of users that

 are displayed on the leaderboard map with all the levels.

 attribute “leaderboard action=leaderb”. The game allows up to 3 FB users displayed.

Default is 1. ( allowed numbers : 1 , 2 or 3)

NoLeaderbLevels (attribute – Ojyaleaderboard BEHAV.):  It is the number of the

game levels: default is 61.

If you change it please change also the coordinates of each level actor

on the two lists: Xpathlblist8 , Ypathlblist8

So the game has the right coordinates to draw the levels and the users on the path.

This is used of course for all levels leaderboard design. (leaderboard action=leaderb)

G-set X maxscale (attribute – Ojyaleaderboard BEHAV.):

It is the maximum score the X scale of the design map path can hold.

For example the single level map can handle for design a max score = 10000 points.

If the user sets the value to 0 than the game sets

X scale maximum score to the highest score done of that level made by a FBuser.

This is for “POST and LEVEL” action design. So single level design.

Instead for “Leaderb” action please this to the number to the maximum length of the

PNG Image of the leaderboard map. (if the the leaderboard map of all levels is

combined by 2 other pngs then this is the sum of them)

The default of our game is 8000 (pixels).

For drawing purposes and designing the background leaderboard map

At trigger event “drawbackground”:

To control the drawing of the pngs maps , the panning of the camera and the limits

of the leaderboard map please use and change those values of the attributes:

Those attributes have the function to stop the panning when the leaderboard map comes to the end of the size.

1. “Xmaxpanning” and “Ymaxpanning” attributes ojyaleaderboard BEHAV.:

Are equal to the length in pixels of the background png file.

In leader action(designing all levels) the game combines 2 pngs of 4000 pixels width

each: So 8000x1500 pixels

(extras folder: pathstencyl10a.png  and pathstencyl10b.png)

So the leaderboard map maximum panning coordinates but in negate

are:  -8000 and -1500

Instead for the other two actions it is: 4064x762 and it is only 1 png .

(extras folder: pathstencyl2.png)

2. xstartbackimg(0) and ystartbackimg(0)

It is the draw start coordinates of the pngs.

3. Xcamstart and Ycamstart

It is the position of the camera actor. It is in negate the half screen size of the game.

The screen size of our game is 1152x768.

So Xcamstart is 1152/2 = 576  and  Yxamstart 768/2=384

See also the PDF file inside the 'Ojyaleaderboard folder' for version 6 details.

Game Ojya Leaderboard

version 7 Wrapper Blocks

Ojya Leaderboard Extension 4 now has wrapper blocks

and also an OpenGraph Celebrate block

Ojya Leaderboard 4 extension has a new mechanism for the calls and callbacks.

We have introduced wrappers for making the calls and getting the callbacks.

This should be obvious as first thought ,BUT facebook calls needs sometimes more attention.

Sometime a wrapper block by its self is very limited.

In certain situations facebook calls must be repeated one more time or two if the certain result is not came with the first callback.

And also, if callback doesn’t come, cause of slow internet or other network errors, the wrapper must be unblocked , with an error message result, so the game can be continued. Otherwise will freeze in that point.

So, with the 14 facebook blocks with wrapper in version 7, we now introduced also a common block named ‘OjyaLB Callback Setting’.

This block must be inserted just before the facebook call block. It contains settings for the call , about the attempts to do IF the condition didn’t arrived with the callback.

Fields:      ‘Not Exists’ - The string condition we search inside the facebook Json callback

                 ‘Retry Sec’ – Make attempts, retry the same call bellow after specific seconds after the first

                  callback came.

                 ‘Attempts’ – Number of the attempts to make with the same call.

                 ‘Unblock Wrapper' – Unblock the wrapper if no callbacks comes, after seconds.

                  Idle callback situation. Seconds calculated like this: (retry sec x Attempts)+1 sec

So , with the above blocks we try to call facebook graph Api /me , and if the first call that comes doesn’t have the string ‘G-OG titleAct’ will make every 2 sec 2 attempts, before we get the final callback result inside the wrapper.

After that, will execute the code inside the wrapper with the ‘callback’ result Json we have.

We can than process it as usual with statements like ‘if’ and

‘else’.

If , no callbacks come at all after 2sec x 2 attempts + 1 sec = 5 sec will unblock the wrapper with a ‘callback’ result of ‘error outoftime’ generated by OjyaLeaderboard extension.

With this way , we have a really easy and powerfull result of controlling our facebook calls and callbacks. Inside our leaderboard game you will see the examples for each call what settings we used.

For example, all facebook calls with an external facebook dialog must have the setting ‘ BlockWrapper’ cause we can unblock the wrapper manually with the dialog, pressing the buttons, ‘OK’ or ‘Cancel’.

You can ofcourse use the settings block with zero attempts and 3-5sec. With this way, with the first callback will give the result without further call attempts. Just put 3-5 seconds just for the ‘UnblockWrapper’ condition, if you don’t want your game to freeze without callbacks from the facebook server.

As you can see, having a wrapper block is really the easiest, cleanest code way to have complete access over your facebook calls.

Game Ojya Leaderboard v8

double extension v8

OjyaLeaderboard4 and OjyaLeaderboard5  Stencyl Extension

SDK4.x  and facebook Analytics

We introduce OjyaLeaderboard v8 with full support of the Android and iOS Facebook SDK 4.x

OjyaLeaderboard v8 now uses the new OjyaLeaderboard5 stencyl extension that has both iOS and Android facebook SDKs version 4.x

We also supply the old OjyaLeaderboard4 with the game V8 which has facebook iOS SDK4.x and facebook Android SDK 3.x. As we mentioned in our forum Android SDK3 is better for gaming and game engines with no code writing as integrates better with the android activities.

But with the new OjyaLeaderboard5 and with facebook Android sdk4 we introduced a unique feature that exists maybe only in Stencyl.

Seamless integration of facebook android sdk4 activities with the activities of the game Stencyl.

This means that when a facebook dialog opens in your game will not stop the main activity of your game, so animation will go on and sounds.

This is a unique feature that does not exists in other game platforms that uses facebook android sdk4.x

This does not occur in facebook iOS SDK or android SDK3.x.

So with this feature we update with the latest facebook SDKs Stencyl facebook integration.

And now OjyaLeaderboard has facebook Analytics supported for your game.

Learn how your game is going as new installs, launches per day etc in real time.

There is also no need to execute a login , just use the 'OjyaLB FB' block once.

( We will support the OjyaLeaderboard4  just for the android sdk3.x )

Just select the extension OjyaLeaderboard 4 or 5. The blocks inside the game are identical.

   Download the script 'TagInsertOjya', or create those tags with the exact name, case-sensitive, before importing the Ojya Leaderboard to your project.

Ojya Leaderboard Score mechanism

No need to pay for third party server leaderboard !

Features the leaderboard has:

    1. Levels , Scores and 1 bonus

    2. Timestamp scores info

    3. Option to keep only the Highest score made per level.

    4. public Lists (<List>) with ordered information per level and score from highest to lower.

    5. Advanced error-free mechanism comparing scores on-line and off-line before posting to server.

    6. Ojya Leaderboard class for Json parse and <List>s management.

  1.  It is a really powerfull , error free mechanism to post to facebook information of the game,

       like Level, score and 1 bonus played hosted on facebook server.

       With this feature you can see all your friends info and design your leaderboard.

  2.  PLUS -  it offers , when the user is not online- an advanved OFF LINE gaming score management.

       This means that you can continue to change score information offline and when the user is online post

       automatic the score back to the server.

       The Ojya Leaderboard saves certain <List>s in the local devices for the off line gaming.

   3.  TIMESTAMP SCORES: Can recognize which score on a specific level was made as last,

        so will keep only the last post score. This is great if user plays the game with different devices also.

   4. After retrieving the score information from facebook the Ojya script 'class-OG Score', creates at the

       end an ordered <List>  'listOrderLevel' that holds all the information ordered per level ,from low to high,

       and each level ordered from highest score to lower.

       Ordered like that it is easy  to retrieve information faster.

       Another important <List> is the 'localScoresList' that holds the User's local-off line scores.

       The other <List> is the 'listfriendsSc' that holds the friend's scores.

       At the 'class-OG Score' you will find all the information of how the lists are used and it is simple.

    5. The mechanism before posting compares those lists above and understands if there are offline scores

        to post or not. Retrieves always the LATEST information from facebook so it is always updated, and

        uses the timestamp to see what is the latest score done by the user.

        Then it posts and takes back also the information again.

        On each final step the Ojya leaderboard save the information , <Lists> to local device always.

        That is why the mechanism is error-free also if you use different devices to play the game.

    6. We created our own JsonParse which has more capabilities on the facebook callback info.

        And also to manage the <LIST>s  our own methods that uses the idea of having an excel table.

        All this in the Gameobject AndyFuncs , script public class-andyfunc.

        Information of how to use it is inside the class.

Posting Scores to Facebook host server

To post scores to the server the ojya leaderboard uses the class-script 'LocalScores' component in the gameobject 'FacebookScripts' of the scene.

You have to set as first thing those 2 variables:

'timestamp' and 'keephighest' .

And then you post using this public method:

public void localScPost(string locallevel, int localscore, int localbonus )

Note: the string locallevel should be  "level20" without space and not just "20"

Use of the 4 important lists in the class 'OGScores'

• localScoresList is the list for local scores of the user-player. Used also for off line gaming
• OGlistMeScores is the facebook server scores <List> of the player.

localScoresList and OGlistMeScores are compared together to post the new scores to server.

After that, the updated scores from the facebook are saved back in the localScoresList.

• listfriendsSc is the friends scores <List>
• listOrderLevel is the ordered list with all the scores. player and friends.

The listfriendsSc (friends) and the localScoresList (user) are combined together to create the

ordered all scores list listOrderLevel ,usefull for the designing of the leaderboard.

The listOrderLevel is ordered like this: from lower level to the highest. Each level has the users

ordered from highest score to lower score.

{ level1/user1/user2/user3, level2/user1/user2/user3,   etc..  }

3. After that Insert the Facebook App information of your game inside our Ojya Scripts.

      a. Go to 'FacebookSettingsEditor' gameObject and insert all the facebook values. This is the class-script 'FacebookSettingsEditor'.

With this information you now have access to all the Ojya Leaderboard features like Levels-Scores-Bonus , sharing helps with friends , posting - challenging your friends in the game by posting to their timeline.

And last note, the OjyaLeaderboard needs the standard facebook permissions for gaming:

public_profile , friends_list, email and of course publish_actions

So, it is really simple and immediate for review.

For more info please read the instructions in the pdf.

(We recommend this site forVector ClipArt - our background - http://shmector.com)

Ojya Leaderboard design levels-scores and challenge.

Ojya Leaderboard - Sharing bonus

Ojya Leaderboard - off line score mechanism

Ojya Leaderboard Version 1.6.2m

Designing and using the leaderboard

Defining the variables

There are only 6 global variables to set for designing the leaderboard.

Are inside the gameobject 'FacebookScripts' , script-class 'LocalScores'

1.  timestamp  -  boolean, to consider only the most recent score for each level. Preferred is TRUE

2.  keephighest -  boolean to keep only the highest score done by the user for each level.

3.  fbset.totalNoLevels  -        Total no of levels in your game , this is used for retrieving the levels from facebook

4.  fbset.designNoLevels -     No of levels for designing purpose.

5.  fbset.designFromLevel -   level to start from for designing purpose.

6.  fbset.lbRowfbusers -         number of fbusers to display in a row for designing.

Diagram of the classes getting the scores and designing the Leaderboard:

Read Only and design:    'LocalScores' ---> 'OGScores' ---> 'DesignScores'

               'OGScores' get also the images from facebook or from the cache.

Post or Read with automatic Post(off-line scores made before) , and design:

              'LocalScores' ---> 'OGScores' ---> 'OGScoresPost' --->'OGScores'  --->'DesignScores'

All levels leaderboard design - Vertical scrolling

Single level leaderboard design - Horizontal scrolling

Posting scores to facebook server - for demo purpose

Share Bonus - facebook apprequests

Defining the variables and using the share bonus

You can share helps or bonus with your friends playing the game.

You can make 3 actions:  1.  'ASK' for help

                                         2.  'GIVE' help to friends they made request

                                         3.  'GET' help from friends uppon request you made using the 'ASK'

Variables to define: for this function the variables are defined in the section 'LEADERBOARD'

Keep in mind that to use this feature the user must be on-line.

Each apprequest has an id and after every action of the user the specific id is deleted from the server.

So the share bonus situation is always update.

Now in Version 2 the player can share multi game items like energy, life, magic portion, keys, weapons etc.

This is a great feature increasing the game experience.

See inside the PDF for full details.

Post to friends facebook wall - Challenge them

Defining the variables and using the challenge feature

The challenge feature is inside the leaderboard panel design of the levels.

Just press on the icon of a fbuser and will post a challenge text and image with the necessary info.

The variables to define by the user are in the gameobject 'FacebookScripts' class-script 'PostChallenge':

  1. message

  2. place  -- this is the Facebook Page ID , fbset.fbPageID global var

  3. link

  4. linkcaption

  5. linkdescription

  6. linkname

Celebrate a victory - Post to facebook wall

Defining the variables and using the celebrate feature

The celebrate feature is inside the leaderboard panel design of the levels.

Just press on the icon of the facebook current player.

The variables to define by the user are in the gameobject 'FacebookScripts' class-script 'PostChallenge', under the line comment : 'OPENGRAPH POST GAMES.CELEBRATE'