Skip to content

Latest commit

 

History

History
54 lines (35 loc) · 1.47 KB

Readme.md

File metadata and controls

54 lines (35 loc) · 1.47 KB

QuestPhone API

Skills Required: Web Development

The QuestPhone API allows external apps to add themselves as a quest. There are
two main ways to add an external integration:

  • The Token Method
  • The JSON Method

Below we describe each in detail.

1. The Token Method

This method is still in development and not yet public.
It will allow external integrations to access the QuestPhone databases and make changes to specific quests, among other capabilities.

2. The JSON Method

This method requires the integration to generate a JSON containing configurations.
QuestPhone parses this JSON and generates a quest from the provided data.

This is the simplest method, and most integrations can be hosted completely on GitHub Pages for free.

It essentially requires you to create two web pages:

  1. Setup Page – Allows users to configure their quest. Example
  2. View Page – Displays when the user opens the quest in QuestPhone. Example

You can read more about creating a setup page here.

QuestPhone allows the view page to access various native QuestPhone functions. Read here.

Testing

You can host your page on your local device using:

python3 -m http.server 8000

Then forward the port for your device:

adb reverse tcp:8000 tcp:8000

Finally, set the webviewUrl field in quest_json as follows:

http://localhost:8000/{yourViewPage.html}