Quick Start & Setup
This guide will take you through the fastest path from signing up to seeing your first optimized results.
1. Access the Console
Section titled “1. Access the Console”Simply sign in to the Hyperstone Console. You can create your first app, define parameters, and launch optimizations immediately — no request or pre-registration required.
2. Set Up Your App
Section titled “2. Set Up Your App”In the Hyperstone Console, you’ll perform the following initial steps:
- Create an app — Register your application and receive an App ID and App Secret. These credentials authenticate your SDK with the Hyperstone server.
- Define parameters — Add the variables you want to optimize (e.g.,
ad_cooldown,starting_coins) and their possible values. - Configure a target metric — Select the metric the algorithm should maximize (e.g., ARPU or Day-7 Retention).
- Launch an optimization — Start the process. The algorithm begins serving configurations to your users immediately.
3. Integrate the SDK
Section titled “3. Integrate the SDK”Hyperstone provides client SDKs that handle the entire integration lifecycle:
- Fetching optimized configurations from the server
- Delivering configuration values to your app code
- Tracking user events (ad impressions, purchases, custom events)
- Batching and sending measurements to the backend
- Managing user identity and session tracking
Supported Platforms
Section titled “Supported Platforms”| Platform | SDK | Status |
|---|---|---|
| Unity | Hyperstone Unity SDK | Available |
| Godot | GDScript | Coming soon |
| Web (JS/TS) | JavaScript SDK | Coming soon |
| Flutter | Flutter SDK | Coming soon |
| Server-to-Server | REST API | Upon request |
Minimum Requirements
Section titled “Minimum Requirements”For Unity integration:
- Unity 2022.3 or later
- Internet access at runtime (the SDK communicates with the Hyperstone API server)
- Your App ID and App Secret from the Console
→ Ready to integrate? Start with Unity SDK Installation.
4. Instrument Your Events
Section titled “4. Instrument Your Events”For the optimization algorithm to learn, it needs to know what users do in your app. The SDK tracks some events automatically (sessions, engagement time, retention), but you’ll need to add event tracking for the things that matter to your specific optimization:
- Ad impressions with revenue data (critical for ad revenue optimization)
- In-app purchases with product and price info
- Custom events specific to your app (e.g.,
level_completed,tutorial_skipped)
The more relevant data you send, the faster and more accurately the algorithm can optimize.
→ See the SDK Integration Guide for details on event tracking.
Quick Checklist
Section titled “Quick Checklist”Use this checklist to make sure you’re ready:
- Console access — You have signed in and created your app
- Parameters planned — You know which values you want to optimize
- Target metric chosen — You’ve decided what to maximize
- App ID & Secret — You have your credentials from the Console
- SDK installed — The Hyperstone SDK is added to your project
- Events instrumented — Your app logs the events the algorithm needs to learn from
- Optimization launched — The optimization is running in the Console
Next Steps
Section titled “Next Steps”Now that you’ve set up the basics, you can dive deeper into the documentation or start analyzing your first results in the Console.