Developer Quick Start
If you just want to jump straight to the essentials, the links you need are all here.
Server API
While most Teak features are handled by the client, some features require server integrations. We recommend starting with the Reward Endpoint (because players love free coins), and then exploring the Server API Overview for a complete look at all backend offerings.
Before You Start
Before you begin integrating Teak into your project, make sure you have:
-
A game project (iOS, Android, or Facebook).
-
The ability to test new builds on devices or simulators/emulators.
-
Access to logs (device console or Unity console) so you can review Teak debugging output.
Preparing Your Game
Depending on your platform and tooling, here are some key setup points before diving into Teak-specific integrations.
If You Use Unity
-
You only need the Unity SDK
-
Start with Getting Started with Teak in Unity
-
Or jump straight to the installation steps: Install the Teak SDK in Unity
If You Use Native iOS
-
Be prepared to modify your
Info.plist. -
Know how to add dependencies (frameworks, libraries) in Xcode.
-
Download the latest iOS Native SDK
-
For full setup details, see Integrating Teak on Native iOS.
If You Use Native Android
-
Be prepared to modify your
AndroidManifest.xml. -
Know how to add dependencies to your
build.gradle. -
Download the latest Android Native SDK
-
For full setup details, see Integrating Teak on Native Android.
Push Credentials
Push notifications are a core part of Teak. Collecting the following credentials in advance will streamline your integration and testing.
iOS
-
A Mac and an Apple Developer account.
-
Follow Apple Push Notification Service Certificates to gather the required credentials.
Android
-
Access to your game in the Firebase Console.
-
Follow Finding your Android Push Credentials on Firebase to retrieve the required configuration for FCM.
Amazon Devices
-
Access to your game in the Amazon Developer Console.
-
Follow the Finding your Amazon Device Messaging Credentials to set up the required credentials.
Next Steps
Here’s a quick recap:
-
Pick Your Platform and follow the relevant integration guide:
-
Native iOS → iOS Native Integration
-
Native Android → iOS Native Integration
-
Secure Your Push Credentials for iOS, Android, and/or Amazon devices.
-
Implement Reward Endpoint if you are responsible for server-side integrations.