0.1.0-alpha.50 • Published 7 months ago

moroboxai-player-web v0.1.0-alpha.50

Weekly downloads
-
License
MIT
Repository
github
Last release
7 months ago

moroboxai-player-web

NPM version Node.js CI gitHub license Code Quality: Javascript Total Alerts

Embeddable player for running MoroboxAI games on the web.

Install

Using npm:

npm install moroboxai-player-web --save

Usage

<html>
    <div id="player"></div>

    <script
        type="text/javascript"
        src="https://cdn.jsdelivr.net/npm/moroboxai-player-web/lib/umd/moroboxai-player-web.min.js"
    ></script>
    <script type="text/javascript">
        // Initialize the player on our div
        const player = MoroboxAIPlayer.init({
            element: document.getElementById("player"),
            url: "https://raw.githubusercontent.com/moroboxai/moroboxai-games/master/games/pong/",
            splashart:
                "https://raw.githubusercontent.com/moroboxai/moroboxai-games/master/games/pong/assets/splashart.png",
            width: 256,
            height: 256
        });

        // Will be called when the game is ready
        player.onReady = () => console.log("game is loaded and ready");

        // Optionally start the game
        player.play();
    </script>
</html>

Arguments

NameTypeDefaultDescription
elementElementDOM element to attach the player to
urlstringURL of the game
headerobjectGame header
splashartstringURL of the placeholder image displayed before the game is loaded
widthnumberWidth of the div element
heightnumberHeight of the div element
resizablebooleantrueIf the game can resize the player
autoPlaybooleanfalseAuto play the game after the player is initialized
speednumber1Speed of the game
agentsarrayAgents to load into controllers
onReadyfuncnoopSignature: function() => void Function called when the game is loaded and ready

Pause

const player = MoroboxAIPlayer.init({...});

pauseButton.onclick = () => player.pause();
playButton.onclick = () => player.play();

Stop

const player = MoroboxAIPlayer.init({...});

stopButton.onclick = () => player.stop();

Reload

const player = MoroboxAIPlayer.init({...});

reloadButton.onclick = () => player.reload();

Stop & Load another game

const player = MoroboxAIPlayer.init({...});

button.onclick = () => player.play("http://url/to/game");

Resize

const player = MoroboxAIPlayer.init({...});
player.width = 128;
player.height = 128;
player.resize({width: 256, height: 256});

Change speed

const player = MoroboxAIPlayer.init({...});
player.speed = 2;

Cleanup

const player = MoroboxAIPlayer.init({...});
player.remove();

License

This content is released under the MIT License.

0.1.0-alpha.50

7 months ago

0.1.0-alpha.30

8 months ago

0.1.0-alpha.32

8 months ago

0.1.0-alpha.34

8 months ago

0.1.0-alpha.33

8 months ago

0.1.0-alpha.36

8 months ago

0.1.0-alpha.35

8 months ago

0.1.0-alpha.37

8 months ago

0.1.0-alpha.39

7 months ago

0.1.0-alpha.41

7 months ago

0.1.0-alpha.43

7 months ago

0.1.0-alpha.42

7 months ago

0.1.0-alpha.45

7 months ago

0.1.0-alpha.44

7 months ago

0.1.0-alpha.47

7 months ago

0.1.0-alpha.46

7 months ago

0.1.0-alpha.49

7 months ago

0.1.0-alpha.48

7 months ago

0.1.0-alpha.19

9 months ago

0.1.0-alpha.21

9 months ago

0.1.0-alpha.20

9 months ago

0.1.0-alpha.23

8 months ago

0.1.0-alpha.22

8 months ago

0.1.0-alpha.25

8 months ago

0.1.0-alpha.24

8 months ago

0.1.0-alpha.27

8 months ago

0.1.0-alpha.26

8 months ago

0.1.0-alpha.29

8 months ago

0.1.0-alpha.28

8 months ago

0.1.0-alpha.14

9 months ago

0.1.0-alpha.13

9 months ago

0.1.0-alpha.16

9 months ago

0.1.0-alpha.15

9 months ago

0.1.0-alpha.18

9 months ago

0.1.0-alpha.17

9 months ago

0.1.0-alpha.10

2 years ago

0.1.0-alpha.12

2 years ago

0.1.0-alpha.11

2 years ago

0.1.0-alpha.9

2 years ago

0.1.0-alpha.8

2 years ago

0.1.0-alpha.7

2 years ago

0.1.0-alpha.6

2 years ago

0.1.0-alpha.5

2 years ago

0.1.0-alpha.4

2 years ago

0.1.0-alpha.3

2 years ago

0.1.0-alpha.2

2 years ago

0.1.0-alpha.1

2 years ago