Advertisement
  1. Code
  2. Games
Code

Getting Started With Scoreoid

by
Difficulty:BeginnerLength:ShortLanguages:

Games are becoming ever more popular, especially casual games on mobile devices and tablets. In these games, the importance of leaderboards is multiplied - and game developers need a simple cross-platform solution for this. In this tutorial we will cover Scoreoid and how it can help you with game development.


About Scoreoid

Scoreoid is a non-restrictive, reliable and easy to use gaming platform designed to handle scoring, leaderboards and game management, including advanced functions for multi-platform games such as platform content awareness and advanced player management. Plus, it truly is developed by game developers for game developers.

Scoreoid’s goal is to handle scoring and leaderboard functionality offering plenty of features to make games better, thereby shortening game development time and costs and giving developers more time to work on their games.

Scoreoid Features

Scoreoid provides game developers with some great features:

  • In-depth game analytics
  • Cross-platform development
  • In game notifications
  • Platform content awareness
  • Ability to export data
  • Multiple user accounts
  • Geo-location
  • Advanced, customizable leaderboards
  • Advanced game achievements

Plus, it's totally free!


Why Choose Scoreoid?

Scoreoid is truly cross-platform: with its Open Web API there is no need to download SDKs and no waiting for updates - and yes, Scoreoid works on every platform (Flash, Unity, HTML5, Silverlight, you name it).

Going beyond the expected

It also allows you to:

  • Create unique leaderboards – display what platform a player is playing from, making your leaderboards very different and attractive to players showing them results from different platforms, and how their own performance compares to that of other players on different platforms.
  • Add in-game notifications – set up easy to use, dynamic notifications for your games. This is great for updating your current players on new game titles, game updates or features. Maybe you want to tell them about your blog or game site. You can even create promotions, raffles, and challenges.
  • Create user saves - with Scoreoid you can easily save a user’s score, completed levels, achievements and much more.
  • Manage players - Scoreoid makes it very easy to manage game players and player scores. It is great to see your top players, but it's also great to be able to capture potential leads for your next game title. Since you keep your players' data and information, you can send out newsletters or updates, or connect on a more personal level with them.
  • Use geo-location – create leaderboards or game achievements based on users' geo-location; show players' top scores based on location or let players compare their scores around the world using maps.

Enough about what it can do. Let's get started using it!


Step 1: Creating an Account and Logging In

Just follow these three steps:

  • Go to scoreoid.com (not .net) and sign up.
  • Activate your account via the activation email.
  • Go back to scoreoid.com and log in.
Scoreoid Sign Up

That's it - no need to download any SDKs.

Dashboard Screen

The dashboard screen contains a number of helpful links and information, including Quick Stats, which let you quickly find out what your most popular game is, who your most popular player is, and so on. They provide an excerpt of what you can find in the full in-game analytics.

See the wiki for more info on this screen.


Step 2: The Game Screen

Before you can start using the Scoreoid platform inside your game you will need to add your game to Scoreoid. This is done by going to the game screen which shows you all your games, has a search option and an option to add a new game.

Game Screen

For each game you will have a list column with the following information:

  • Game Name - Your game name. Selecting the name will open up a lightbox to let you edit your game's information.
  • Game ID (Token) - This is a 9 digit hash ID used for making API calls. You can copy it to your clipboard using the copy button or reset it via the actions section.
  • Version - Displays game version based on your input when adding a new game.
  • Platform - Displays game platform based on your input when adding a new game. If your game is active on more than one platform use “,” to separate each platform (this is passed as an array to the Scoreoid API).
  • Players - Shows your currently player count.
  • Created - The date you added your game to Scoreoid, automatically generated via Scoreoid.
  • Status - Your game status, clicking on this will either deactivate or activate your game.
  • Actions - This section gives you a few items: a direct link to the scores screen; the ability to reset your Game ID (this will stop any API calls inside any active games); and buttons to edit or delete the selected game.

Step 3: Adding your game to the Scoreoid platform

Clicking on the “Add new game” button will open the "create game" lightbox, and you will have a number of options to fill out:

Create Game
  • Name of the game
  • Short description - Used for auto post and advanced APIs.
  • Game description
  • Game Type - Action, RPG, etc. Used for advanced stats.
  • Version - Your game's version number.
  • Levels - Number of levels; will be used for advanced global stats (currently not supported).
  • Download/Play URL - Your game's URL in HTTP:// format. Used for auto post and advanced APIs.
  • Website URL - Your website or your game's website URL in HTTP:// format. Used for auto post and advanced APIs.

Although only the game name is required we recommend filling out all the information, as more APIs will be added which will use the remaining info.


Step 4: Understanding the Console

The Scoreoid console screen lets you access Scoreoid’s Open Web API where you can call any one of the create or get API methods. The console screen is a great way to learn and test out Scoreoid; it also makes it very easy to copy the required parameters or find the API method that would work best for your game.

Console Screen

Clicking on an API method will open the API lightbox where you will have access to the API's URL and POST parameters (API method options), your API key, your game ID, the response type, and any other parameters or options that are required.

API Lightbox

Clicking the button to make the method call will show you the API response lightbox, which has the generated response.

API Response Screen

Step 5: Scoreoid’S Open Web API

Scoreoid’s Open Web API methods are RESTful HTTP/HTTPS requests which return XML or JSON responses. The Scoreoid Open Web API works with every coding language making it truly cross platform and easy to use.

You well always have the following parameters that are required:

api_key - Your API Key
game_id - Your Game ID
response - String Value, "XML" or "JSON"

While Scoreoid supports both HTTP and HTTPS, we recommend using HTTPS as it is more secure.

Step 6: Creating a Score and Retrieving Scores

Creating a score with Scoreoid is easy. You have a number of API methods that offer this option; the easiest and fastest one is createScore().

All of Scoreoid's API methods will return a response letting you know that the information was saved - or that there was an error with the passed parameters.

API URL: https://www.scoreoid.com/api/createScore

POST Parameters:

api_key - Your API Key [required]
game_id - Your Game ID [required]
response - String Value: "XML" or "JSON" [required]
score - Number Value: the player's score [required]
username - String Value: the player's name [required]

Create Score API Method

You have more options: like username, platform, unique id and difficulty. None of these are required, but they can offer more benefits; for example, you could splits scores into different platforms or difficulties, or lock a player into a device or platform using their unique id.

Here is the response when a score has been submitted and successfully saved:

Score Saved

Here is the response when a score has been submitted but there was an issue or error:

Score Saved Error

As you can see Scoreoid provides full validation options making sure you always know what’s going on.

Retrieving scores to be displayed inside your game's leaderboards can be done by using the getScores() API method:

API URL: https://www.scoreoid.com/api/getScores

POST Parameters

api_key - Your API Key [required]
game_id - Your Game ID [required]
response - String Value: "XML" or "JSON" [required]
order_by - String Value: "date" or "score" [optional]
order - String Value: "asc" or "desc" [optional]
limit - Number Value: "20" retrieves rows 1 - 20; "10,20" retrieves rows 11-30 [optional]
start_date - Date Value: YYYY-MM-DD [optional]
end_date - Date Value: YYYY-MM-DD [optional]
platform - String Value: needs to match with all API methods used [optional]
difficulty - Number Value: 1 to 10 [optional]

Get Scores API Method

As you can see there are plenty of options for segmenting and retrieving scores. Here is the response in JSON and XML format:

Get Scores API Response JSON
Get Scores API Response XML

Step 7: Creating a Player With Game Achievements

Scoreoid has a great built in method for creating a player, with a number of options including current level, XP, energy, and more. We’re going to use this method for game achievements.

With the createPlayer() API method we have a number of options for achievements we can list all of the game's achievements using the “achievements” parameter and then use the “current_achievements” parameter to list the player's current achievements. Another option is just listing the players achievements directly using any one of the parameters available.

API URL: https://www.scoreoid.com/api/createPlayer

POST Parameters

api_key - Your API Key [required]
game_id - Your Game ID [required]
response - String Value: "XML" or "JSON" [required]
username - String Value: the player's name [required]
achievements - Comma Separated Array Value: the player's achievements [optional]

Create Player API Method

As you can see there are plenty of other options which lets you add even more details to your players.

But let’s look another example: suppose you already created you player and only want to update a certain parameter - for instance, their achievements, lives, or XP.

Scoreoid has a number of APIs like editPlayer(), getPlayerField(), and updatePlayerField(). Let’s use updatePlayerField() to update a player's in-game achievements.

Update Player Field

As you can see, I entered the player's username, selected the field that I wanted to update, and entered the desired new value. Once the update is made, Scoreoid returns an API response to let you know that the field has been updated:

Update Player Field Response

Of course all this will be done via your game's code rather than the website's interface, so here is the full code example.

API URL: https://www.scoreoid.com/api/updatePlayerField

POST Parameters

api_key - Your API Key [required]
game_id - Your Game ID [required]
response - String Value: "XML" or "JSON" [required]
username - String Value: the players name [required]
field - The field you would like to update [required]
value - The new value [required]


Scoreoid Tips and Tricks

Here are some best practices that we recommend:

  • Save locally - It’s always best to save locally first, and then send the data.
  • Check connection - Always check that the player has an Internet connection; if they don’t, then save the data locally and then send it when a connection is available.
  • Make fewer calls - The fewer HTTPS calls you make the better.
  • Notify - Always let your players know what’s going on; make sure to tell them that the information has been saved.
  • Timing - Choose the right time to send data; for example, never send data during game play (between screens is usually a perfect time to send data).
  • Customize - Customize your leaderboards to fit within your game's design.
  • Creativity - Get creative with your leaderboards: go beyond the expected with charts or text maps, or make your leaderboards unique.
  • Filters - Provide filters and options for your leaderboards.
  • In Game Notifications - Use In Game Notifications to update your players about news or cross-promotions.
  • Leaderboards - Leaderboards provide more exposure and better retention, plus they motivates gamers - so use them!

Conclusion

Scoreoid is all about the developers and community. If you have an idea for a great feature or suggestion, or require a specific feature for your game, please send us feedback. There is much more to Scoreoid than we could possibly have covered here, so make sure you check out the rest of the Scoreoid’s features at scoreoid.net and stay tuned as we roll out new features.

Thank you for reading this tutorial and I hope you learned something new.

Advertisement
Advertisement
Looking for something to help kick start your next project?
Envato Market has a range of items for sale to help get you started.