Vorld Documentation
Documentation
Setup Arena Arcade Game
Complete step-by-step guide to set up your Arena Arcade game for real-time multiplayer experiences with streaming integration.
Step 1: Create Vorld Auth App
First, you need to create a Vorld Auth application to get your App ID for Arena Arcade integration.
Vorld Auth App Created
After creating your Vorld Auth app, you'll see the app details with your App ID. Keep this App ID secure as you'll need it for Arena Arcade setup.
Step 3: Navigate to Arena Arcade Portal
Once Game Developer mode is enabled, you'll see the "ARENA ARCADE" tab in the dock.
Arena Arcade Portal
Click on the "ARENA ARCADE" tab in the dock to access the Arena Arcade Portal.
Create Game Button
In the Arena Arcade Portal, you'll see a "Create Game" button to start setting up your game.
Step 4: Create Game Form
Fill out the game creation form with your app name and select your Vorld App ID.
Game Creation Form
Fill out the form with your app name and select the Vorld App ID you created in Step 1.
Game Created Successfully
After submitting the form, your Arena Arcade game will be created. Copy the Game ID and other important details.
Important: Copy your Game ID, WebSocket URL, and other integration details. You'll need these for the next steps.
Step 5: Manage App - Default Configuration
Click on "Manage App" to access the game configuration and set up your Arena Arcade features.
Default Configuration
You'll see the default configuration for your Arena Arcade game. This includes basic settings that you can customize.
Step 6: Create Players
Players are the characters or entities that will participate in your Arena Arcade game.
What are Players?
Players represent the characters, avatars, or entities that will be controlled by users in your game. They can be heroes, enemies, or any game character with specific attributes and abilities.
Step 7: Events
Events are triggers that occur during gameplay to create dynamic and engaging experiences.
Event Integration Tutorial
Watch this video to understand how to integrate events in your application.
What are Events?
Events are special triggers that can be activated by the game. They can include special events, activites and notify them to the users and airdropers, they are custom to the game and used to improve the gameplay experience.
Step 8: Packages
Packages are items that can be dropped by stream viewers to help certain actors or enemies inside the game. They can be used to either help actors or make the gameplay difficult for actors.
Package Types
There are two main types of packages in Arena Arcade:
Immediate Packages
Immediate packages are dropped immediately after purchase into the game and can provide immediate help boost or enemy effects.
Cyclic Packages
Cyclic packages are packages that are dropped after each cycle based on the amount of boost provided by the stream viewers. They put arena coins as boost and unlock various packages. Packages are reset after each cycle drop and this event is emitted with the package data. Cyclic packages are sorted on the basis of unlock points - same unlock points are categorized into one single level.
Package Features
Each package can have different features and configurations:
Stats
Stats are descriptions of your packages that add a visual description of the package like damage range or other properties. They provide clear information about what the package does and its effects.
Cost
Cost will be the arena coins that are required to either unlock that or drop that package.
Custom Metadata
Custom metadata are custom fields that you can add into the packages that can be used to help in the game development process.
Example of a package form filled with data.
