IntroductionWiMi5 is an online game engine that allows game developers to create, publish and monetize HTML5 games. It includes a visual scripting tool for creating the logic of your game so you don't have to code. It's free and is in Beta. Each game created with WiMi5 has a ranking assigned to it by default. Using it is optional, and the decision to use it is totally up to the developer. It's very easy to handle, and we can sum it up in three steps, which are explained below.
- Firstly, the setup is performed in the Ranking section of the project's properties, which can be accessed from the dashboard.
- Then, when you've created the game in the editor, you'll have a series of blackboxes available to handle the rankings.
- Finally, once it's running, a button will appear in the game's toolbar (if the developer has set it up that way) with which the player can access the scoreboard at any time.
Setting up the Rankings
Remember that since it's still in beta, the settings are limited. So we need you to keep a few things in mind: - The game is only assigned one table, which is based both on the score obtained in the game and on the date that score was obtained. In the future, the developer will be able to create and personalize their own tables. - The ranking has several setup options available, but most of them are preset and can't be modified. In later versions, they will be.In the dashboard, in the project's properties, you can access the rankings' setup by clicking on the Rankings tab. As you can observe, there is a default setting.
Display the button in the game's toolbarThis option is selected by default, and allows the button to show rankings to appear on the toolbar that's seen in every game. If you're not going to use rankings in your game, or don't want that button to appear, in order to have more control over when the scoreboard will be shown, all you have to do is deactivate this option. The button looks like this:
Only one result per userNOTE: The modification of this option is turned off for the time being. This allows you to set up whether a player can have multiple results on the scoreboard or only their best one. This option is turned off by default, meaning all the player's matches with top scores will appear. It's important to note that if this option is turned off, the player's best score is the only one that will appear highlighted, not the last. If the player has a lower score in a future match, it will be included in the ranking, but it may not be shown since there's a better score already on the board.
Timeframe SelectionNOTE: The modification of this option is turned off for the moment, and is only available in all-time view, which is further limited to the 500 best scores. This allows the scoreboard to have different timeframes for the same lists: all-time, daily, monthly, and yearly. The all-time view is chosen by default, which, as its name implies, has no time limit.
Match data used in rankingsNOTE: The modification of this option is turned off for the moment. The internationalization of public texts is not enabled. This allows you to define what data will be the sorting criteria for the scoreboard. The Points item is used by default; another criterion available is Date (automatically handled by the system), which includes the date and time the game's score is entered. Of each of the data that is configured, we have the following characteristics reflected in the board columns:
- Priority: This indicates the datum's importance in the sorting of the scoreboard. The lower the number, the more important the datum is. In the default case, for example, the first criterion is points; if there are equal points, then by date.
- ID: Unique name by which the datum is identified. This identifier is what will appear in the blackboxes that allow the rankings' data to be managed.
- Type: The type of data.
- List order: Ascending or descending order. In the default case, it will be descending for points (highest number first), and should points be equal, by ascending order by date (oldest games first).
- Visible: This indicates if it should be shown in the scoreboard. That is to say, the datum is taken into account to calculate the ranking position, but it is not shown later on the scoreboard. In the default case, the points are visible, but the date and time are not.
- Header title: The public name of the datum. This is the name the player will see on the scoreboard.