Skip to content

Commit

Permalink
Updating docs from Marketing
Browse files Browse the repository at this point in the history
  • Loading branch information
spenceryyt committed Nov 16, 2023
1 parent 8d79ee6 commit 29455fb
Show file tree
Hide file tree
Showing 12 changed files with 275 additions and 65 deletions.
Binary file added .github/Developer_Journey.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added .github/User_Journey.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
30 changes: 19 additions & 11 deletions account.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,26 +3,34 @@ title: Catalyst Account Setup
route: /account-setup
tags: ['account', 'login', 'registration', 'api', 'key']
layout: default
order: 7
date: 2023-08-02
order: 9
date: 2023-11-16
---

Setting up your account is easy, we’re also happy to help you get it done. Just contact someone from our team, and we’ll assist you as soon as possible.
Let’s delve deeper into each aspect of creating a rewarding gaming environment that is exhilarating for your users.

Sign up for an account with us and log into the dashboard located at <https://app.conductive.ai>
### Account Setup

A project will automatically be set up for you; just simply retrieve your API key.
**Registration on the Conductive.ai platform**

### API Key
[Registering on the Conductive.ai platform](https://noteforms.com/forms/conductive-product-onboarding-form?utm_source=homepage&notionforms=1) is your first step towards leveraging a toolkit designed to boost player lifetime value (LTV) and retention. Developers will find straightforward options to sign up, with guidance at each step ensuring a hassle-free registration process. Once registered, developers gain access to a suite of features aimed at incentivizing player engagement through stablecoin rewards.

You will first want to acquire an API key by visiting the dashboard <https://app.conductive.ai> and selecting the settings icon at the bottom and then “Settings”.
**Project setup and API key retrieval**

![](https://github.com/conductiveai/catalyst-unity-sdk/blob/main/.github/settings.png?raw=true)
To initiate your project setup, visit [https://app.conductive.ai](https://app.conductive.ai/) and log in to obtain your unique API key for integrating Conductive.ai’s toolkit into your system. Do this by clicking the settings icon at the bottom and selecting “Settings”:

This should take you to the project settings below. Copy the API key provided for your project.
This should take you to the project settings below. Copy your API key provided for your project:

![](https://github.com/conductiveai/catalyst-unity-sdk/blob/main/.github/settings2.png?raw=true)
The API key acts as a secure bridge between your project and the Conductive.ai platform, facilitating secure data transfers and authorizing access to various functionalities. Safeguard your API key as it is essential to maintain the security and smooth operation of your services on the platform.

Now that you have your API key, you can continue to install the SDK remotely or locally.
**Defining the organization and understanding user roles (Admin/Client/Developer)**

Understanding the different user roles — Admin, Client, and Developer — is important for managing and navigating the Conductive.ai platform.

- **The Admin** oversees the organizational settings and manages user roles, ensuring that operations run seamlessly.
- **The Client** role is generally reserved for individuals or entities making use of the services, having privileges to set up and manage projects under the guidance of an Admin.
- **The Developer** role is targeted towards individuals responsible for the technical integration and maintenance of projects, having the authority to access and manage API settings and other technical resources.

Defining each role clearly can streamline operations and foster a collaborative, efficient working environment.

Continue to the `Unity SDK` section.
13 changes: 8 additions & 5 deletions events.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ title: Sending Events in Catalyst
route: /sending-events-in-catalyst
tags: ['events', 'analytics', 'capture', 'identity']
layout: default
order: 5
date: 2023-08-02
order: 7
date: 2023-11-16
---
# Sending Events in Catalyst

Expand Down Expand Up @@ -87,8 +87,11 @@ Tracking screens is incredibly beneficial as it enables us to monitor both user

### User Synchronization

This method is used to connect a player’s user ID in a game with their Catalyst ID to synchronize data with Conductive’s services. This is a necessary step when creating contests that utilize a Leaderboard. Adding this line of code when a user logs into the game ensures we can synchronize data.
Please open the `CatalystSDK.cs` script in the `CatalystSDK` folder. Then, edit this line of code to synchronize player IDs with Catalyst services.

```csharp
CatalystSDK.Instance.SetExternalId("USER_ID_1");
```
//Set your game's user id here to synchronize data with Catalyst services
SetExternalId("USER_ID");
```

This method is used to connect a player’s user ID in a game with their Catalyst ID to synchronize data with Conductive’s services. This is a necessary step when creating contests that utilize a Leaderboard. Updating this line of code when a user logs into the game ensures we can synchronize data.
2 changes: 1 addition & 1 deletion example.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: SDK Events Examples
route: /sdk-events-examples
tags: ['examples', 'sdk', 'unity', 'custom']
layout: default
order: 4
order: 6
date: 2023-08-02
---
# Event example
Expand Down
2 changes: 1 addition & 1 deletion glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Glossary
route: /glossary
tags: ['glossary', 'definition', 'terms']
layout: default
order: 9
order: 11
date: 2023-08-02
---
The following is a non-exhaustive list of technical terms used by Conductive.ai that may be referenced throughout this document.
Expand Down
148 changes: 148 additions & 0 deletions playerengagement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
---
title: How to Set Up Your First Contest
route: /contest-setup
tags: ['walkthrough', 'engagement', 'contest', 'setup']
layout: default
order: 4
date: 2023-11-16
---

### Conductive Button

Use the **SceneToShowButton** field to set where the Conductive Button appears in your game. We recommend showing the button in a lobby screen or main menu.

The Conductive Button, which will be featured in-game, is part of the `CatalystSDK.prefab`. Out of the box, it will feature an image, along with a countdown clock that indicates when your active contest will end. The button also supports badges that notify players when a contest ends and if they won a prize for the contest period. If your team has suggestions on notifications that can better inform your players about the contest status or rewards, please get in touch with Conductive.ai. We are constantly making improvements to Conductive Catalyst SDK, and your feedback is valuable.

We understand that resolutions and formats need to be adjusted on a per-game basis, so the button has its own canvas. While properties like resolution and size can be adjusted, we recommend keeping other elements unchanged, as a static button with no countdown might result in lower engagement or a confused player base.

### Player Engagement Mechanics

**Funding the Master Wallet**

**Stablecoins Supported:**

- USDC & USDT (ERC-20)
- USDC & USDT (Polygon)
- USDT (BNB)

**Purpose:** These stablecoins can be utilized as rewards.

### Catalyst Account:

**Purpose:** This account is crucial for processing on-network operations.

**Scenario 1: Deposit ETH in preparation for creating a contest on the Ethereum network.**

ETH will be used to cover any gas fees associated with transactions such as sending stablecoin rewards directly to players.

### Buying ETH on a centralized cryptocurrency exchange:

- Start by visiting a centralized cryptocurrency exchange, such as [Coinbase](https://www.coinbase.com/), and creating an account.
- Follow the exchange's step-by-step instructions for buying ETH. [Here is Coinbase's walkthrough.](https://www.coinbase.com/how-to-buy/ethereum)
- When the purchase is complete, you will see your ETH balance in your Coinbase Wallet Balance.

### Obtaining your Catalyst Account wallet address:

- Visit the Catalyst Dashboard.
- In the upper right, click on **Fund Project**.
- Copy your wallet address, which is a string of alphanumeric characters starting with **0x**.
- Set this wallet address aside. You will need it when you withdraw ETH from your cryptocurrency exchange.

### Sending ETH to your Catalyst Account Master Wallet:

- Sign in to your centralized cryptocurrency exchange of choice. In this example, we'll proceed with the assumption that you are using [Coinbase](https://www.coinbase.com/).
- Click the Trading tab.
- Under Wallet Balance, select Withdraw.
- Search for ETH.
- Choose the withdrawal method: in the **To** field, enter your Catalyst Account Master wallet address.
- Confirm you're withdrawing ETH into the correct address.
- Enter the amount of ETH you'd like to send to your Catalyst Account Master Wallet.
- You may need to enter two-step verification before completing the withdrawal.
- Note that you will need to reserve a small amount of ETH to pay network fees (also called gas fees) for the withdrawal.

**Scenario 2: Deposit MATIC in preparation for creating a contest on the Polygon network.**

MATIC will be used to cover any gas fees associated with transactions such as sending stablecoin rewards directly to players.

### Buying MATIC on a centralized cryptocurrency exchange:

- Start by visiting a centralized cryptocurrency exchange, such as [Coinbase](https://www.coinbase.com/), and creating an account.
- Follow the exchange's step-by-step instructions for buying MATIC. [Here is Coinbase's walkthrough.](https://www.coinbase.com/how-to-buy/polygon)
- When the purchase is complete, you will see your MATIC balance in your Coinbase Wallet Balance.

### Obtaining your Catalyst Account wallet address:

- Visit the Catalyst Dashboard.
- In the upper right, click on **Fund Project**.
- Copy your wallet address, which is a string of alphanumeric characters starting with **0x**.
- Set this wallet address aside. You will need it when you withdraw MATIC from your cryptocurrency exchange.

### Sending MATIC to your Catalyst Account Master Wallet:

- Sign in to your centralized cryptocurrency exchange of choice. In this example, we'll proceed with the assumption that you are using [Coinbase](https://www.coinbase.com/).
- Click the Trading tab.
- Under Wallet Balance, select Withdraw.
- Search for MATIC.
- Choose the withdrawal method: in the **To** field, enter your Catalyst Account Master wallet address.
- Confirm you're withdrawing MATIC into the correct address.
- Enter the amount of MATIC you'd like to send to your Catalyst Account Master Wallet.
- You may need to enter two-step verification before completing the withdrawal.
- Note that you will need to reserve a small amount of MATIC to pay network fees (also called gas fees) for the withdrawal.

**Creating a Reward Group:**

**Objective:** Set up a reward pool or distribution group for specific players or activities.

**Procedure:** Send your desired amount of ERC-20 tokens (such as USDC or USDT) to the designated reward group address or through the specified platform interface.

***Note:** Before transferring any funds, always ensure that you’re using the correct and official addresses or methods to prevent any loss of assets. All gas fees will be paid for by the developer from the Master Wallet.*

### **Setting up and customizing reward groups and rewards**

Upon registering on the Conductive.ai platform, it is crucial to set up and personalize your reward groups and the rewards.

This entails defining various reward categories, which include leaderboards and quests.

To create a leaderboard, you will have to set up the ranks and define the prizes that players will receive when they achieve those ranks.

Here’s how to setup a leaderboard:

1. Give Conductive.ai a leaderboard API endpoint
2. 2. Speak with a Conductive.ai representative to share the value you want to track that determine ordinal placement.
3. Tell Conductive.ai how we can retrieve user data from your leaderboard data, and the timestamp
4. This will allow us to configure your unique leaderboard for Conductive.ai services


### **Implementing and managing contests and leaderboards**

To foster a competitive spirit and maintain high engagement levels, Conductive.ai offers integrated tools for implementing and managing contests and leaderboards developed by the game developer with ease. Conductive.ai can read a game's leaderboard and extract data to prove winners and give those winners rewards.

Developers have the flexibility to set up periodic contests linked to an in-game leaderboard. These features track player performances and rankings. The management process is iterative, requiring updates based on player feedback. The aim is to ensure fairness and make necessary adjustments over time to sustain a lively and engaging gaming atmosphere.

### **Catalyst Dashboard**

From the Catalyst Dashboard, developers will be able to carry out a wide range of actions to enhance the gaming experience and foster greater player engagement.

Here’s a breakdown of the functionalities available:

- **Create Contests:** Set up competitive events to spur engagement and retain players.
- **Display Contests**: Showcase ongoing contests vividly to engage players effectively.
- **Delete Contests:** Remove contests that are outdated or irrelevant to maintain a streamlined player experience.
- **Update Scheduled Contests**: Modify scheduled contests to adapt to changing dynamics or improve engagement. You cannot modify or update a contest after it has gone live.
- **Create Reward Groups:** Establish groups with specified rewards to encourage certain player behaviors.
- **Display Reward Groups:** Illustrate reward groups prominently to keep players informed and motivated.
- **Delete Reward Groups:** Withdraw reward groups that are no longer beneficial or pertinent.
- **Update Reward Groups:** Revise reward groups to keep them fresh, relevant, and aligned with your game’s goals.
- Name your reward group (example: Contest #4 Winners!)
- Reward Amount
- Range (i.e: 1–10 = top ten players on leaderboard will split the reward for the contest)
- **Set Withdraw Limit:** Configure the minimum amount of token rewards a user must accumulate before they can transfer rewards to their wallet.
- **Fund Master Wallet:** Ensure a seamless reward distribution process by managing financial resources effectively.

Through the Conductive.ai dashboard, developers have a centralized hub to manage and optimize the reward systems effectively, encouraging a thriving gaming community centered around continuous engagement and rich rewards. This set of tools is crafted to facilitate not just the creation and management of contests and rewards, but also to visualize and analyze data essential in iterating a successful game development strategy. It is the linchpin in creating a vibrant and responsive gaming ecosystem, enabling a deeper connection between the game and its community.

**Understanding reward transactions and withdrawal thresholds**

An essential aspect of managing the Conductive.ai platform is understanding the dynamics of reward transactions and establishing reasonable withdrawal thresholds. This involves setting a minimum limit of accumulated rewards that players must reach before initiating a withdrawal. These thresholds can be adjusted at any time.

By having a deep understanding of this, you can maintain a healthy ecosystem where players feel rewarded appropriately while preserving the economic balance of the rewards system. Establishing and communicating these thresholds clearly helps in fostering a transparent and trustful environment, encouraging players to engage more and aim higher in their gaming pursuits.
Loading

0 comments on commit 29455fb

Please sign in to comment.