Actions on Google Canvas Plugin for RPG Maker

NOTE

This is an experimental project and will receive minimal maintenance. Only bugs for security issues will be accepted. No feature requests will be accepted. Pull requests will be acknowledged and reviewed as soon as possible. There is no associated SLAs.

Some of the projects in this experimental org might mature to a more stable state and move into the main Actions on Google GitHub org.

This is a JavaScript plugin for RPG Maker MV which makes it easy to incorporate support for the Google Assistant with a zero-configuration plugin.

This repository also includes a sample game that can be used to quickly get started.

Setup

Setup Plugin

Clone this project and
Download the file https://www.gstatic.com/assistant/interactivecanvas/api/interactive_canvas.min.js to /path/to/my-game/js/libs/canvas.js
Copy the file canvas-plugin.js to /path/to/my-game/js/plugins/canvas-plugin.js
Open RPG Maker > Plugins
- Select an empty row. A window will open.
- Select Canvas from the dropdown
- Select OK
Go to File > Deployment...
- Select Web browsers as the platform
- Set the Output directory to the same directory as your project
- Select OK
- Rename the game folder to www

Your game will be saved to the specified file location.

Setup Actions on Google project

From the Actions on Google Console, add a new project > Create Project > under More options > Conversational
From the top menu under Deploy > Directory information (left nav)
1. Under Category, select Games & fun
2. Under Interactive Canvas Do your Actions use Interactive Canvas?, check Yes
From the left menu under Develop > Actions > Add your first action > Play game > GET STARTED IN DIALOGFLOW (this will bring you to the Dialogflow console) > Select language and time zone > CREATE.
In the Dialogflow console, go to Settings ⚙ > Export and Import > Restore from zip using the agent.zip in this sample's directory.

Firebase Deployment

On your local machine, in the functions directory, run npm install
Run firebase deploy --project {PROJECT_ID} to deploy the function and hosting
- This will upload functions from the functions directory, and your game files from the www directory
- To find your Project ID: In Dialogflow console under Settings ⚙ > General tab > Project ID.

Dialogflow Console

Return to the Dialogflow Console > select Fulfillment > Enable Webhook > Set URL to the Function URL that was returned after the deploy command > SAVE.
```
Function URL (dialogflowFirebaseFulfillment): https://${REGION}-${PROJECT_ID}.cloudfunctions.net/dialogflowFirebaseFulfillment
```
From the left navigation menu, click Integrations > Integration Settings under Google Assistant > Enable Auto-preview changes > Test to open the Actions on Google simulator then say or type Talk to my test app.

References & Issues

Questions? Go to StackOverflow, Assistant Developer Community on Reddit or Support.
For bugs, please report an issue on Github.
Actions on Google Interactive Canvas Documentation
Actions on Google Documentation
Actions on Google Codelabs
Webhook Boilerplate Template for Actions on Google

Make Contributions

Please read and follow the steps in the CONTRIBUTING.md.

License

See LICENSE.

Terms

Your use of this sample is subject to, and by using or downloading the sample files you agree to comply with, the Google APIs Terms of Service.

actions-on-google-labs / interactive-canvas-rpg-maker-nodejs