1
1
# Poki Phaser 3 Plugin
2
+ A Phaser 3 plugin to easially integrate the Poki SDK
3
+
4
+ - - -
2
5
3
6
Hi! 👋 This is the official Poki Phaser Plugin for
4
7
[ Phaser 3] ( https://phaser.io/phaser3 ) . This plugin will automate most of
@@ -26,12 +29,12 @@ always check the example in the [/example](example/) directory.
26
29
27
30
### Add the dependency
28
31
29
- First, you have to make sure to add the ` poki- phaser-3 ` plugin as a dependency
30
- to your project:
32
+ First, you have to make sure to add the ` @ poki/ phaser-3` plugin as a dependency
33
+ to your project:
31
34
``` bash
32
- $ npm install --save-dev poki- phaser-3
35
+ $ npm install --save-dev @ poki/ phaser-3
33
36
# or
34
- $ yarn add --dev poki- phaser-3
37
+ $ yarn add --dev @ poki/ phaser-3
35
38
```
36
39
<small >(note: at the time of writing, not yet published to npm)</small >
37
40
@@ -40,7 +43,7 @@ $ yarn add --dev poki-phaser-3
40
43
Step two is to add the plugin to the plugins section of your Phaser
41
44
configuration, for example:
42
45
``` javascript
43
- import { PokiPlugin } from ' poki- phaser-3'
46
+ import { PokiPlugin } from ' @ poki/ phaser-3'
44
47
// ...
45
48
const config = {
46
49
// ...
@@ -132,20 +135,6 @@ Server running at http://localhost:1234
132
135
And point your browser to http://localhost:1234
133
136
134
137
135
- ## TODO
136
-
137
- This project is currently in an early development phase. These steps are still
138
- left before we can publish it for general use:
139
-
140
- - [x] Get it to work localhost
141
- - [x] Auto mute & Disable keyboard input
142
- - [x] Extend example with buttons to show off all plugin features (e.g. rewarded
143
- ad)
144
- - [x] Write readme & instructions
145
- - [x] Go over all exposed function/variable names
146
- - [ ] Package into downloadable .js and publish to npm
147
- - [ ] Test it in an existing game
148
-
149
138
## Asset Credits
150
139
151
140
Background music credits:
0 commit comments