Skip to content

breederdao/creatorverse-plugins-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 

Repository files navigation

Creatorverse Plugins Docs

Base API Reference

Base URL http://bdao-ecs-crtrvrs-wallet-api-dev-2122478437.ap-southeast-1.elb.amazonaws.com/api/v1

Output Pin Structure for All Blueprints:

  • OnSuccess: Triggered upon a successful API request.
  • OnFail: Triggered if an error occurs during the API request.
  • Data: Holds data from a successful API request (only available when OnSuccess is activated).
  • Message: Contains error message for a failed API request (populated when OnFail is triggered).
  • Response Code: Indicates the HTTP response code received.

Installation

  1. Request CreatorVerse UE plugins from the BreederDAO team.
  2. Navigate to your root project directory. Create a new folder named Plugins and add the received plugins to this folder.
  3. Open the Unreal Engine editor. You will be prompted to compile the plugin. Follow the on-screen instructions to complete the compilation process.
  • Search for the BreederDAO subsystem.

Screenshot 2023-09-27 at 1 13 36 PM

BreederDAO Blueprints

Registration

Description:

Enables users to create a Creatorverse account.

API Reference:

Registration

Input Pin:

  • Username
  • Email
  • Password
  • Confirm Password

Email Verification:

Upon registration, users receive a verification email to confirm the validity of their email address.

Login

Description:

Facilitates user login to the Creatorverse game.

Pre-requisite:

  • User must be registered.

API Reference:

Login

Input Pin:

  • Email or Username
  • Password

Data Struct:

Login Struct

Note: Upon successful login, a Bearer token will be generated. This token is essential for accessing other APIs within the Creatorverse ecosystem.

Get User Data

Description:

Retrieve user account data, including user information, DATs, and currency balances.

Pre-requisite:

  • User must be logged in.

API Reference:

Login

Data Struct:

Login

Get User Dats

Description:

Fetch the current user’s DATs.

API Reference:

Login

Data Struct:

Login

Get User Currencies Balance

Description:

Retrieve the current user’s currency balances.

API Reference:

Login

Data Struct:

Login

Get All DATS

Description:

Access a complete list of playable DATs in the game.

API Reference:

Login

Data Struct:

Login

Add User DAT

Description:

Associate specific DATs with a player's account. Obtain UserId by calling the Get User Data plugin.

Input Pin:

  • UserId
  • Dat Enum

Add User DAT Enum

API Reference:

Add User DAT

Data Struct:

Add User DAT Data

Update User Currency Balance

Description:

Modify a player's currency balance. Use -1 for Gems, Relics Fragments, and Cores to retain the current balance. UserId can be obtained through the Get User Data plugin

Input Pin:

  • Gems
  • Relics Fragments
  • Cores

API Reference:

Add User DAT

Data Struct:

Add User DAT Data

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published