Testnet: Cloud Gaming Work Guide
Overview
The Aethir cloud gaming platform utilizes cloud computing technology. It draws on a vast network of stable distributed computing nodes and uses dependable audio and video transmission technology. This setup allows games to run directly in the cloud. As a result, players can enjoy a high-quality, seamless gaming experience on any device. For game developers, the Aethir platform simplifies the process. Instead of navigating a complicated development and adaptation process, developers can swiftly deploy and launch their games online using Aethir.
Below is a comparison between traditional gaming and cloud gaming:
Advantages of Aethir Cloud Gaming
Mature Technology: Aethir's cloud gaming platform is built on a proprietary technical architecture. This ensures low latency, high-resolution graphics, and a seamless playing experience—even in areas with weak network connections.
Cost Efficiency: With a comprehensive operation and maintenance management system, Aethir supports a variety of container specifications. This approach substantially lowers operational costs for partners.
Flexible Deployment: The platform boasts a robust virtualization strategy, optimizing the use of available hardware. It also facilitates horizontal scaling—automatically adjusting container instances based on demand. This eases the deployment, scaling, and management of container-centric applications.
Global Reach: Aethir's platform has a widespread presence with nodes across various continents, offering partners a globally expansive resource selection.
System Architecture
Application Scenarios of the Cloud Gaming Platform
High-Quality Gameplay: Enables players to enjoy smooth, high-quality game content through lightweight clients or browsers across diverse devices.
Promotional Trial Play: Offers users an instant play trial experience without the need for downloads, catering to various promotional needs.
Live Interaction: In live game broadcasts, viewers have the option to join the game in real-time. This allows them to interact with the broadcaster while watching the stream.
Mini Client: Converts large games into mini client APK packages, which are less than 50 MB in size. This not only reduces barriers for user experience but also enhances customer retention.
Terminology
Aethir Cloud Gaming Platform: A platform that offers streamlined access to cloud gaming services. It caters to a variety of stakeholders including game developers, content producers, channel creators, and other clientele.
Games and Game Versions: Within the Aethir platform, a "game" is treated as an entity or set. Within this set, multiple "game versions" can be created. For each version within the "game" set, users can submit, modify, or delete game adaptation services. Furthermore, they can deploy and make available specific "game versions" for players.
Deployment: On the Aethir platform, deployment refers to a concurrent instance. This instance embodies a collection of virtual computing resources, comprising fundamental components such as the CPU, operating system, network, disk, and GPU.
Quick Start Guide
This section provides straightforward steps to help game developers easily integrate their games into the Aethir cloud gaming platform.
Step 1: Registration
If you haven’t yet registered, visit the Aethir cloud gaming platform and sign up for an account.
Step 2: Service Application
Complete your account and business details to apply for the cloud gaming service.
Step 3: Game Submission
Navigate to the 'Game List' page to create a game.
Add the required game version details under 'Game List - Version' to proceed with game adaptation.
For more information, refer to the Game Management section.
Step 4: Game Adaptation
Aethir's platform will handle the game's adaptation. Our team will liaise with you to confirm necessary running parameters during this process.
Step 5: Game Deployment
Based on your deployment preferences, go to the 'Deployment List' page.
Choose the game and its version, specify the deployment region, decide on the number of instances, and submit the deployment request.
For a detailed walkthrough, check out the Deployment Management section.
Step 6: SDK Integration
After deploying the game, begin the integration of the cloud gaming SDK. Ensure you connect the relevant APIs based on your requirements.
For Cloud Gaming Platform APIs, see: Cloud Gaming Platform Integration Guide.md
For Android SDK, see: Android SDK Integration Guide.md
For JS SDK, see: Cloud Gaming JSSDK Integration Guide.md
Step 7: Game Launch
With the SDK integration complete, your game is ready to go live.
Monitor performance metrics in the Aethir cloud gaming dashboard or manage cloud gaming sessions via the 'Session List'.
Operation Guide
Account Registration
Navigate to the Aethir cloud gaming platform's web portal.
Click on 'Sign Up' to access the registration page.
Fill in details such as your name, email, company name, and others to complete the registration.
Note: A console permission review typically takes between 1-3 days. Our team will reach out to you during this period.
Game Management
In this section, you'll learn how to submit the game adaptation service and manage game versions.
Concept Clarification: Here, a "Game" is referred to as a collection, and you can create multiple "Game versions" within each "Game" collection. Every version in the "Game" set allows you to submit, alter, or delete its game adaptation service.
Specific Functions for Game Management:
List of games
The game list showcases all your games for easy management.
Display Details: The list will show the game ID, game name, type (like PC Windows or mobile Android), description, when it was created, and the count of versions associated.
Game Management: For every game, you have the options to add, delete, modify, or view detailed versions.
Accessing Versions: Click on 'Version' to explore the specific list of game versions.
Search Function: You can conveniently search for games using their ID or name.
Deletion Prompt: If a game has an associated deployment, a message will appear: "The game still has deployment, cannot be deleted." When you decide to delete, it will disappear from the list, and its contained game versions will also be removed.
Adding a Game
Initiate the process by clicking on ‘Add game’.
A pop-up window will appear. Here, you'll need to provide details like game name, game type, and game description.
After entering the details, click 'OK'.
Upon successful creation, the system will allocate a unique game ID to the newly added game.
Version List
Your game version list interface aids in the effective management and viewing of game versions. Here's a rundown of its features:
Primary Information: At the top, you'll find details like the game ID, game name, and game type.
Detailed Display: The list presents the game version number, its current adaptation status, online state, anticipated resolution, a brief description, release date, and the count of games that are in service. The list organizes games from the highest to lowest version number by default.
Adaptation Status: Game versions have distinct adaptation statuses like 'Verifying', 'Packaged', and 'Invalid'. Online states can be 'Online' or 'Offline'.
New Version Process: Adding a new game version means it will enter the 'Verifying' phase after your submission. The platform's team manually starts the game adaptation. Once this is over, the upgrade package will be uploaded, causing the version to transition to the 'Packaged' phase. Following this, the game version will be 'Online' and ready for deployment.
Managing 'Online' Version: For versions currently 'Online', clicking the 'Offline' button prompts a confirmation. Confirming this will set the version to 'Offline', disabling its deployment, and making it unplayable.
Managing 'Offline' Version: If a game version is 'Offline', pressing the 'Online' button will prompt a second confirmation. Confirming will set the game to 'Online', making it playable again. However, if its adaptation status isn't 'Packaged', you can't carry out the online operation.
Adding a Game Version
Start by clicking on ‘add game version’.
A pop-up window will ask for specific details: version download link, download MD5, version description, and the original version number.
Once you've provided the required information, submit the adaptation.
Successful submissions will receive a unique version number from the system, and the version status will then shift to the 'Verifying' stage for review.
Deployment Management
Efficiently manage the deployment of games with the Aethir cloud gaming platform’s deployment management interface. Deploy your game versions to containers in specific regions to provide seamless cloud gaming services to players within those regions.
Deployment List Features:
Initial Setup: A game version has to be deployed to a designated region prior to the container installation process.
List View: The list displays attributes like deployment ID, name, status, region, specifications, game/version details, game installed capacity, creation date, and service fees.
Instance Limitations: An instance is compatible with only one application. It's possible to deploy an application across various regions, but duplicating in the same region is not permitted.
Actions Available: Users can add, modify, update, test, or remove deployments.
Filtering & Search: Filter your deployments by region or search using deployment names.
Deployment States: Deployments have three states - 'Verifying', 'In Service', and 'Invalid'. New deployments initially enter the 'Verifying' stage. Upon successful manual background verification, they transition to the 'In Service' state.
Removing Deployments: Clicking "Remove" prompts a confirmation. Once confirmed, the game stops scheduling, the deployment shifts to 'Invalid', and the installation count diminishes to zero.
Version Upgrades: When a version is upgraded, the containers in that region will progressively incorporate the updated game version. During this period, the deployment remains 'In Service', allowing the old version to still function. The installed capacity reflects both the new and old version installations.
Editing Deployments: To make modifications, simply click on the 'Edit' option which directs you to the deployment editing interface.
Initiating a New Deployment:
Start by selecting 'New deployment'.
A pop-up will appear prompting for details such as deployment name, region, game, version, and deployment count.
After entering the necessary details, submit your request.
The system then allocates a unique deployment instance ID to your new deployment, placing it in the 'Verifying' status. Following successful background validation, the designated region's container automatically starts downloading and setting up the specified application.
Session Management
Ensure smooth gameplay experiences by actively managing and monitoring game sessions using the Aethir cloud gaming platform’s session management interface.
Session List Features:
Overview: The session list provides comprehensive data including session ID, game ID, container ID, player ID, status, service quality, start and end times, among other parameters.
Session Interactivity: By delving into session details, users have the capability to terminate active or ongoing sessions.
Completion Timestamp: Once a session concludes, its end time gets documented for reference.
Search Functionality: Easily locate specific data by searching through container ID, Game ID, or tenant ID.
In-depth Session Insights: Clicking on 'Details' unveils an expanded view of the session information. This encompasses attributes such as resolution, bit rate, encoding type, duration of the session, service quality, hardware specifics, and the player's device type.
Dashboard Overview
Dive deep into the analytics of your games with the comprehensive Aethir cloud gaming platform dashboard. Track, measure, and visualize important metrics to make informed decisions.
Key Features of the Dashboard:
Daily Cloud Gaming Rendering Time: Understand the daily utilization of the platform by tracking the total rendering time.
Player Metrics: Gain insights into the number of players engaging with your games on any given day, helping you gauge game popularity and user engagement.
Average Online Time: Measure the average duration players spend on your games. This can offer insights into game stickiness and areas that might need improvement.
Service Fee Expenditure: Keep a close eye on your costs with a real-time view of your service fee expenditure, ensuring you remain within budget and optimizing where necessary.
Popular Game Rankings: Identify which games are trending and resonating most with players. This can help in shaping future game development or marketing strategies.
Comprehensive Data Visualization: With easy-to-read graphs, charts, and tables, you can quickly identify patterns, track growth, or spot potential issues.
SDK Introduction
The Aethir cloud gaming Software Development Kit (SDK) is designed to seamlessly bring the power of the cloud to your gaming experience. It's a comprehensive toolset that enables game developers and platform managers to tap into the concurrent services offered by the Aethir cloud gaming PaaS platform. Here's a brief overview of its capabilities:
Front-end SDK Introduction
The Aethir cloud gaming SDK integrates directly into your gaming business, enabling smooth interaction with game deployment and distribution services. Its functionalities include:
Request Session:
Seamlessly apply for a session service directly through the cloud gaming SDK.
Upon session creation requests, the Aethir cloud gaming platform assigns a relevant container to execute cloud gaming rendering.
Session Management:
Status Queries: Use the SDK to monitor game queuing statuses and ensure efficient session allocation.
Game Status Notifications: Keep players informed with real-time updates about their game status including initiation, ongoing gameplay, completion, or unexpected termination.
User Management: Gain insights into individual user game times and statuses. Plus, retain control by having the capability to forcibly exit specific users from a game.
Operation Management:
Game Controls: Start and stop games effortlessly.
Session Management: In case of disconnections, reconnect seamlessly to the session.
Customization: Personalize bit-rate settings for optimal performance.
Multimodal Interactions: The SDK supports various input mechanisms including touch, keyboard, mouse, physical game controllers, and even customized virtual controllers.
Platform-Specific SDKs
Different platforms require specialized tools. We offer:
Android SDK: Tailored for Android devices, it's designed for optimal performance on Android-based systems. For a detailed integration process, refer to the 'Android SDK Integration Guide.md'.
JS SDK: For web-based platforms, the Cloud Gaming JavaScript SDK ensures smooth cloud gaming experiences directly in browsers. Integration specifics can be found in the 'Cloud Gaming JSSDK Integration Guide.md'.
Best Practices
Navigating the world of cloud gaming can seem intricate, but with a few best practices, you can optimize the gaming experience for both developers and players. Here are some fundamental practices for game upgrades and virtual buttons on the Aethir cloud gaming platform.
Game Upgrades
As games evolve, they require updates to incorporate new content or fix bugs. Here’s a streamlined way to manage game upgrades on the Aethir platform:
Submission of New Version:
Initiate by navigating to the 'Game Management' section.
Select the game requiring an update and go to 'Version'.
Add a new version, providing the necessary details.
Post submission, the version status will read "Verifying". Once the adaptation is complete, the status transitions to "Packaged".
Deployment of Updated Version:
Move to the 'Deployment List' page.
Pick the deployment necessitating an update, hit 'Update', and choose the intended game version.
Submit to conclude the upgrade. The Aethir platform will methodically update deployed instances to this version.
For grayscale testing, specify the deployment number during upgrade configuration.
Playing the Upgraded Game:
After initiating the deployment upgrade, players can access the game in its updated version.
You can always check the 'Deployment List' page for the status of the new version’s deployment.
If the new game version demands different hardware specs than the original, a fresh game and deployment need to be established. Post this, based on necessity, you can remove the outdated version and its deployment.
Virtual Buttons
For an enhanced gaming experience on mobile devices:
Gamepad Mapping: With mobile devices lacking physical buttons, virtual gamepad mapping becomes crucial. The Aethir platform offers dynamic configurability for the virtual button layout, enhancing the game's control and feel.
Reference: View the gamepad.md for comprehensive information on setting up the gamepad JS SDK.
Keyboard & Mouse Mapping: Some games are best played with a keyboard or mouse input, even on mobile. The platform supports such mappings, ensuring players have versatile control methods regardless of the device.
Reference: Dive into the keyboard.md to get insights on setting up keyboard and mouse JS SDK.
Web2 vs. Web3 Mini Client Access Process
In the realm of online platforms, Web2 represents the second generation of internet services that focus on user-generated content, while Web3 refers to a new paradigm for applications on the internet. Web3 is a decentralized internet where applications are based on a blockchain or peer-to-peer (P2P) architecture. Let’s break down their access processes, especially when integrated with the Aethir cloud gaming platform.
Web2 Mini Client Access Process
Login:
Players authenticate on the micro client.
The Aethir platform can send the login account to the cloud APP via:
Windows: Command line.
Android: System broadcast message.
Cloud APP: Integration of a massage SDK for seamless transmission.
Payment:
The platform boasts an end-to-end transparent messaging channel between the client and cloud APP.
Payment modes include:
QR code display and scanning.
Pulling up a third-party APP for payment.
Redirecting to a third-party H5 page.
Web3 Mini Client Access Process
Essentially identical to Web2 with a variation in payment:
Payment:
For mobile Android/iOS: Pull up the MetaMask APP for transactions.
Web2 PC Web Access Process
Login:
Players can either log in by inputting their credentials on a browser or redirecting to a third-party login portal.
Payments:
Upon payment initiation, redirect to:
A third-party payment H5 page.
Scan a QR code.
Input card details for transactions.
Web3 PC Web Access Process
Mimics the Web2 PC web process, albeit a change in the payment method:
Payments:
Initiate a transaction by pulling up the browser-supported MetaMask plugin.
Both Web2 and Web3 processes have their distinct advantages and applications. Web2’s structure is based on centralized servers, making it streamlined and more straightforward. On the contrary, Web3 operates on decentralized platforms, offering more security and transparency, especially in payment methods. Depending on the specific requirements and the user base's preferences, developers can choose between the two while integrating with the Aethir cloud gaming platform.
Last updated
