https://github.com/florianvazelle/phaser3-vjoy-plugin

Virtual Joystick plugin for Phaser3
https://github.com/florianvazelle/phaser3-vjoy-plugin

joystick npm npm-package phaser phaser-plugin phaser3 phaser3-plugin phaserjs plugin

Last synced: about 1 month ago
JSON representation

Virtual Joystick plugin for Phaser3

• Host: GitHub
• URL: https://github.com/florianvazelle/phaser3-vjoy-plugin
• Owner: florianvazelle
• License: mit
• Created: 2018-12-03T11:58:34.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2022-02-13T20:50:56.000Z (over 2 years ago)
• Last Synced: 2024-09-18T17:14:50.530Z (about 2 months ago)
• Topics: joystick, npm, npm-package, phaser, phaser-plugin, phaser3, phaser3-plugin, phaserjs, plugin
• Language: JavaScript
• Homepage: https://florianvazelle.github.io/phaser3-vjoy-plugin/
• Size: 1.52 MB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Phaser 3 VJoy Plugin 

[![Package version](https://img.shields.io/npm/v/phaser3-vjoy-plugin)](https://nodei.co/npm/phaser3-vjoy-plugin/)

![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/phaser3-vjoy-plugin)

![npm bundle size](https://img.shields.io/bundlephobia/min/phaser3-vjoy-plugin)

![Total downloads](https://img.shields.io/npm/dt/phaser3-vjoy-plugin)

[![License](https://img.shields.io/npm/l/phaser3-vjoy-plugin)](https://opensource.org/licenses/MIT)

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 `` tag in the browser, or loaded by Node.js or another bundler.

## Getting Started

To install it with [npm](https://www.npmjs.com), run :

```

npm i phaser3-vjoy-plugin --save

```

## Usage

### Load the Plugin

As in the [phaser documentation](https://photonstorm.github.io/phaser3-docs/Phaser.Plugins.PluginManager.html#installScenePlugin__anchor), do something like this :

```javascript

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 : 

```javascript

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

```

### Examples

To test the plugin, check the [online demo](https://florianvazelle.github.io/phaser3-vjoy-plugin/).

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](https://github.com/florianvazelle/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](https://github.com/InformalPenguins/phaser-vjoy-plugin)

- Using of [Phaser3 Plugin Template by Photonstorm](https://github.com/photonstorm/phaser3-plugin-template)

Good plugin examples:

- [Phaser Lifecycle Plugin by Sporadic Labs](https://github.com/sporadic-labs/phaser-lifecycle-plugin)

- [Phaser3 Plugin Project Starter by Agogpixel](https://github.com/agogpixel/phaser3-plugin-project-starter)