Quest

Introduction / Summary

Quest is a dynamic hide and seek game where an admin can drop multiple quest items within a world for users to find.

Built With

Client

Server

Key Features

• Search the world to find Quest items
• Collect up to a specified number per day
• Keep up your daily quest to stay on top of the leaderboard

Canvas elements & interactions

• Key Asset: When clicked this asset will open the drawer and allow users and admins to start interacting with the app.
• Quest Items: When clicked the user will be credited with finding the Quest item and the item will then be hidden again somewhere else in the world

Drawer content

• Leaderboard
• Admin settings
• Quest item found details

Admin features

• Click on the key asset to open the drawer and select the Admin tab
• From here you can do the following:
  • Update Number Allowed To Collect Per Day. Changing this will change the number of Quest items a user can collect in a given day.
  • Update Quest Item Image URL. Change this will immediately change all Quest items already dropped in world. Note: This will not change the Key Asset image (see Implementation).
  • Click the Hide in world button to hide a new Quest item somewhere in the world. Once it's been placed you'll see it added to the bottom of the Placed items list
  • Click the Remove all button to remove all Quest items currently dropped in the world.
  • The Placed Items table shows a list of all existing Quest items. Clicking on the Walk to Item icon button will move your avatar to that place Quest item. Clicking on the Remove Item button will immediately remove the place Quest item from the world.

---

Implementation Requirements

Required Assets with Unique Names

Unique Name Pattern	Description
questItem_{sceneDropId}	Quest items dropped in the world. The app uses this pattern to track and manage quest items.

Environment Variables

Create a .env file in the root directory. See .env-example for a template.

Variable	Description	Required
NODE_ENV	Node environment (development or production)	No
PORT	Server port (default: 3000)	No
INSTANCE_DOMAIN	Topia API domain (api.topia.io for production, api-stage.topia.io for staging)	Yes
INTERACTIVE_KEY	Topia interactive app key	Yes
INTERACTIVE_SECRET	Topia interactive app secret	Yes
WEB_IMAGE_ASSET_ID	Asset ID used to create web image assets for quest items (default: webImageAsset)	No
DEFAULT_EGG_IMAGE_URL	Default image URL for quest egg items	No
DEFAULT_KEY_ASSET_IMAGE_URL	Default image URL for the key asset	No
DEV_URL	Development URL (e.g., ngrok URL for webhook forwarding)	No
EMOTE_NAME	Name of the emote to trigger on quest completion (e.g., quest_1)	No
GOOGLESHEETS_CLIENT_EMAIL	Google service account email for analytics	No
GOOGLESHEETS_SHEET_ID	Google Sheet ID for analytics	No
GOOGLESHEETS_PRIVATE_KEY	Google service account private key	No

---

Developers

Getting Started

• Clone this repository
• Run npm i in server
• cd client
• Run npm i in client
• cd .. back to server

Add your .env environmental variables

See Environment Variables above.

Where to find INTERACTIVE_KEY and INTERACTIVE_SECRET

Topia Dev Account Dashboard

Topia Production Account Dashboard

Data objects

We use data objects to store information about each implementation of the app per world.

• Dropped Assets: the data object attached to the dropped assets can optionally include questItemImage which will be used instead of the default image when someone first interacts with the instance of Quest. Additionally it'll capture user progress to be displayed in the leaderboard

  • leaderboard (leaderboard.${profileId})

• World: the data object attached to the world will store information for every instance of the app in a given world by sceneDropId and will persist if a specific instance is removed manually from world instead of through the Admin screen.

  • questItems (scenes.${sceneDropId}.questItems.${assetId})

• User: the data object attached to the user will store user's progress per instance of Quest across all worlds.

  • currentStreak
  • lastCollectedDate
  • longestStreak
  • totalCollected
  • totalCollectedToday

Helpful links

• SDK Developer docs

• Notion One Pager