Leaderboard Merger: Difference between revisions

From SlimLukeGames Wiki
Jump to navigation Jump to search
Created page with "Leaderboard Merger is a standalone hardware device responsible for collecting leaderboard data from a defined set of boxer machines, merging those results into a single ranking, and presenting the combined leaderboard on its own display. The device operates independently from the boxer machines and periodically synchronizes data according to the selected connection scenario. == Machine List Configuration == Leaderboard Merger requires a configuration file containing a..."
 
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
Leaderboard Merger is a standalone hardware device responsible for collecting leaderboard data from a defined set of boxer machines, merging those results into a single ranking, and presenting the combined leaderboard on its own display.
Leaderboard Merger is a standalone hardware device responsible for collecting leaderboard data from a defined set of arcade machines, merging those results into a single ranking, and presenting the combined leaderboard on its own display.


The device operates independently from the boxer machines and periodically synchronizes data according to the selected connection scenario.
The device operates independently from the arcade machines and periodically synchronizes data according to the selected connection scenario.
 
== Machine List Configuration ==
 
Leaderboard Merger requires a configuration file containing a list of machine serial numbers. Only machines listed in this file will be queried for leaderboard data.
This mechanism allows precise control over which machines participate in the merged leaderboard (for example: machines located in a single venue, hall, or event zone).


== Connection Scenarios ==
== Connection Scenarios ==
Line 15: Line 10:
* Global
* Global


Each scenario defines how the device communicates with boxer machines and how frequently the data is refreshed.
Each scenario defines how the device communicates with arcade machines, how the data is obtained, and how frequently the leaderboard is refreshed.


=== Local Scenario ===
=== Local Scenario ===


In the local scenario, the Leaderboard Merger and all boxer machines must be connected to the same local wireless network (WLAN).
In the local scenario, the Leaderboard Merger and all arcade machines must be connected to the same local wireless network (WLAN).
 
Key characteristics:
 
* No internet connection is required.
* All devices must be in the same WLAN.
* Data refresh interval is '''5 seconds'''.
* This mode is recommended for on‑site installations such as arcades, bars, or live events.


* No internet connection is required
Typical use cases:
* Data refresh interval is 5 seconds.
* This mode is recommended for on‑site installations such as arcades, bars, or events.
* Typical use cases: single venue, event installation, temporary locations without internet access


Notice: If no existing WLAN is available at the location, the Leaderboard Merger can be configured to create its own wireless access point. In this setup:
* Single venue installations
* Leaderboard Merger acts as the Wi‑Fi access point
* Event-based setups
* Boxer machines connect directly to this network
* Temporary locations without internet access


=== Global Scenario ===
=== Global Scenario ===


In the global scenario, the Leaderboard Merger and boxer machines communicate over the internet.
In the global scenario, the Leaderboard Merger and arcade machines communicate over the internet.
 
In this mode, the Leaderboard Merger requires a configuration file containing a list of machine serial numbers. Only machines listed in this file will be queried for leaderboard data. This allows precise control over which machines participate in the merged leaderboard (for example: machines belonging to a specific venue, region, or event).


Key characteristics:
Key characteristics:
Line 38: Line 39:
* Each device connects to an internet‑enabled WLAN
* Each device connects to an internet‑enabled WLAN
* Devices do not need to be on the same local network
* Devices do not need to be on the same local network
* Data is retrieved via remote servers
* Data is retrieved via a remote server
* Data refresh interval is 60 seconds.
* Configuration file with machine serial numbers is required
* This mode is suitable for aggregating leaderboards from geographically distributed locations.
* Data refresh interval is '''60 seconds'''
* Typical use cases: chain locations, distributed tournaments, global or regional rankings
* This mode is suitable for aggregating leaderboards from geographically distributed locations
 
Typical use cases:
 
* Chain locations
* Distributed tournaments
* Global or regional rankings
 
== Settings ==
 
=== Configuration file ===
 
Notice: As of 2025-12-16, the configuration file can only be created and deployed by the producer. Operator-side configuration tools are still under development.
 
File <code>Data/serials.json</code> is required for operation in the Global scenario. It defines the list of arcade machine serial numbers whose leaderboard data will be collected and merged.
 
Example content of the file:
 
{
  "_version": 1,
  "serials": [
    "1111222233334444",
    "5555666677778888"
  ]
}
 
=== Access Point Mode ===
 
If no existing WLAN is available at the location, the Leaderboard Merger can be configured to create its own wireless access point.
 
In this setup:
 
* Leaderboard Merger acts as the Wi‑Fi access point
* Arcade machines connect directly to this network
* No external network infrastructure is required

Latest revision as of 13:46, 16 December 2025

Leaderboard Merger is a standalone hardware device responsible for collecting leaderboard data from a defined set of arcade machines, merging those results into a single ranking, and presenting the combined leaderboard on its own display.

The device operates independently from the arcade machines and periodically synchronizes data according to the selected connection scenario.

Connection Scenarios

Leaderboard Merger supports two operating modes:

  • Local
  • Global

Each scenario defines how the device communicates with arcade machines, how the data is obtained, and how frequently the leaderboard is refreshed.

Local Scenario

In the local scenario, the Leaderboard Merger and all arcade machines must be connected to the same local wireless network (WLAN).

Key characteristics:

  • No internet connection is required.
  • All devices must be in the same WLAN.
  • Data refresh interval is 5 seconds.
  • This mode is recommended for on‑site installations such as arcades, bars, or live events.

Typical use cases:

  • Single venue installations
  • Event-based setups
  • Temporary locations without internet access

Global Scenario

In the global scenario, the Leaderboard Merger and arcade machines communicate over the internet.

In this mode, the Leaderboard Merger requires a configuration file containing a list of machine serial numbers. Only machines listed in this file will be queried for leaderboard data. This allows precise control over which machines participate in the merged leaderboard (for example: machines belonging to a specific venue, region, or event).

Key characteristics:

  • Each device connects to an internet‑enabled WLAN
  • Devices do not need to be on the same local network
  • Data is retrieved via a remote server
  • Configuration file with machine serial numbers is required
  • Data refresh interval is 60 seconds
  • This mode is suitable for aggregating leaderboards from geographically distributed locations

Typical use cases:

  • Chain locations
  • Distributed tournaments
  • Global or regional rankings

Settings

Configuration file

Notice: As of 2025-12-16, the configuration file can only be created and deployed by the producer. Operator-side configuration tools are still under development.

File Data/serials.json is required for operation in the Global scenario. It defines the list of arcade machine serial numbers whose leaderboard data will be collected and merged.

Example content of the file:

{
  "_version": 1,
  "serials": [
   "1111222233334444",
   "5555666677778888"
  ]
}

Access Point Mode

If no existing WLAN is available at the location, the Leaderboard Merger can be configured to create its own wireless access point.

In this setup:

  • Leaderboard Merger acts as the Wi‑Fi access point
  • Arcade machines connect directly to this network
  • No external network infrastructure is required