Phaser 3 VJoy Plugin

A simple plugin for Phaser 3, to allow you to use a joystick in your computer or mobile game.

The output javascript package is a classic script that could be loaded in a <script> tag in the browser, or loaded by Node.js or another bundler.

Getting Started

To install it with npm, run :

npm i phaser3-vjoy-plugin --save

Usage

Load the Plugin

As in the phaser documentation, do something like this :

import 'phaser';
import VJoyPlugin from 'phaser3-vjoy-plugin';

...

this.plugins.installScenePlugin('VJoyPlugin', VJoyPlugin, 'vjoy', this);

// and from within the scene :
this.sys.VJoyPlugin; // key value
this.vjoy; // mapping value

or, if you just use the dist file :

this.load.scenePlugin('VJoyPlugin', './VJoyPlugin.js', null, 'vjoy');

Examples

To test the plugin, check the online demo.

If you want to see the full implementation, you can find an example in the demo directory. You can run npm run demo to test it.

Or, if you want to use import statement, you can go to phaser3-vjoy-plugin-demo.

Development

Run npm install and then npm run build to build the plugin.

References

• Based on Phaser VJoy Plugin by Informal Penguins
• Using of Phaser3 Plugin Template by Photonstorm

Good plugin examples:

• Phaser Lifecycle Plugin by Sporadic Labs
• Phaser3 Plugin Project Starter by Agogpixel