3.3.3 • Published 2 days ago

@casual-simulation/aux-vm-browser v3.3.3

Weekly downloads
408
License
MIT
Repository
github
Last release
2 days ago

AUX VM Browser

npm (scoped)

A set of utilities required to run an AUX in a web browser.

Installation

  1. Install the NPM package
npm install @casual-simulation/aux-vm-browser
  1. Add the WorkerEntry.js file to your Webpack config:
entry: {
    vm: path.resolve(
        __dirname,
        'node_modules',
        '@casual-simulation',
        'aux-vm-browser',
        'html',
        'WorkerEntry.js'
    ),
},
  1. Add the iframe_host.html file to your webpack config via the HtmlWebpackPlugin:
new HtmlWebpackPlugin({
    chunks: ['vm'],
    template: path.resolve(
        __dirname,
        'node_modules',
        '@casual-simulation',
        'aux-vm-browser',
        'html',
        'iframe_host.html'
    ),
    title: 'AUX VM',
    filename: 'aux-vm-iframe.html',
}),
  1. Ensure that aux-vm-iframe.html is available at the root path of the site.

Usage

Connect to an AUX

import { BotManager, AuxVMImpl } from '@casual-simulation/aux-vm-browser';
import { AuxUser } from '@casual-simulation/aux-vm';

start();

async function start() {
    // The user that we want the program to act as.
    // In a real-world scenario we would not hardcode these values
    // and we would store the token in a secure location.
    const user: AuxUser = {
        id: 'myUserId', // The Unique ID of this user session.
        username: 'myUsername', // The unique username of the user.
        name: 'myName', // The common name of the user.
        token: 'mySecretToken', // The user password.
        isGuest: false, // Whether the user should be treated as a guest.
    };

    // The ID of the channel that should be loaded.
    // The ID can have the following forms:
    // - 'channelId' - This will load 'channelId' from the current host (taken from navigator).
    // - 'https://example.com/*/channelId' - This will load 'channelId' from example.com over https
    const id = 'channelId';

    const config = {
        isBuilder: false,
        isPlayer: false,
    };

    const partitions = BotManager.createPartitions(id, user, config);

    // Create a file manager.
    // This represents an in-browser AUX simulation.
    const sim = new BotManager(
        user,
        id,
        config,
        new AuxVMImpl(user, {
            config,
            partitions,
        })
    );

    // Initialize the simulation.
    // This will setup a web worker and pipe
    // events between the worker and main thread.
    await sim.init();

    // Listen for the sync state to change to "synced".
    // When we're synced we know we have the most up to date data
    // and we can communicate our changes to the server.
    // Note that this will not fire if we are not allowed to connect.
    // This may happen if we are not authenticated/authorized.
    sim.connection.syncStateChanged.subscribe((synced) => {
        if (synced) {
            console.log("We're synced!");

            // TODO: Update THE UI
        } else {
            console.log('No longer synced.');

            // TODO: Update the UI
        }
    });
}
3.3.3

2 days ago

3.3.2

12 days ago

3.3.1

15 days ago

3.3.0

26 days ago

3.2.19

1 month ago

3.2.18

2 months ago

3.2.17

2 months ago

3.2.16

3 months ago

3.2.15

3 months ago

3.2.14

3 months ago

3.2.13

3 months ago

3.2.12

3 months ago

3.2.11

3 months ago

3.2.10

4 months ago

3.2.9

4 months ago

3.2.8

4 months ago

3.2.7

5 months ago

3.2.2

9 months ago

3.2.1

10 months ago

3.2.0

10 months ago

3.2.6

8 months ago

3.2.5

9 months ago

3.2.4

9 months ago

3.2.3

9 months ago

3.1.36

10 months ago

3.1.35

11 months ago

3.1.32

11 months ago

3.1.30

12 months ago

3.1.31

12 months ago

3.1.29

12 months ago

3.1.25

1 year ago

3.1.26

1 year ago

3.1.28

1 year ago

3.1.23

1 year ago

3.1.24

1 year ago

3.1.22

1 year ago

3.1.18

1 year ago

3.1.21

1 year ago

3.1.20

1 year ago

3.1.19

1 year ago

3.1.7

2 years ago

3.1.9

2 years ago

3.1.8

2 years ago

3.1.12

1 year ago

3.1.11

1 year ago

3.1.14

1 year ago

3.1.16

1 year ago

3.1.17

1 year ago

3.1.10

2 years ago

3.1.3

2 years ago

3.1.6

2 years ago

3.1.4

2 years ago

3.1.2

2 years ago

3.1.1

2 years ago

3.1.0

2 years ago

3.0.20

2 years ago

3.0.12

2 years ago

3.0.13

2 years ago

3.0.11

2 years ago

3.0.16

2 years ago

3.0.17

2 years ago

3.0.14

2 years ago

3.0.15

2 years ago

3.0.18

2 years ago

3.0.6

2 years ago

3.0.5

2 years ago

3.0.9

2 years ago

3.0.10

2 years ago

3.0.4

2 years ago

3.0.3

2 years ago

3.0.2

2 years ago

3.0.1

2 years ago

3.0.0

2 years ago

2.0.27

2 years ago

2.0.22

2 years ago

2.0.23

2 years ago

2.0.21

2 years ago

2.0.28

2 years ago

2.0.29

2 years ago

2.0.35

2 years ago

2.0.36

2 years ago

2.0.34

2 years ago

2.0.31

2 years ago

2.0.32

2 years ago

2.0.30

2 years ago

2.0.16

2 years ago

2.0.19

2 years ago

2.0.17

2 years ago

2.0.18

2 years ago

2.0.15

3 years ago

2.0.14

3 years ago

2.0.13

3 years ago

2.0.12

3 years ago

2.0.11

3 years ago

2.0.10

3 years ago

2.0.9

3 years ago

2.0.8

3 years ago

2.0.7

3 years ago

2.0.6

3 years ago

2.0.4

3 years ago

2.0.3

3 years ago

2.0.2

3 years ago

2.0.1

3 years ago

2.0.0

3 years ago

1.5.11-alpha.42

3 years ago

1.5.11-alpha.41

3 years ago

1.5.11

3 years ago

1.5.14

3 years ago

1.5.16

3 years ago

1.5.15

3 years ago

1.5.17

3 years ago

1.5.19

3 years ago

1.5.21

3 years ago

1.5.23

3 years ago

1.5.22

3 years ago

1.5.24

3 years ago

1.5.11-alpha.40

3 years ago

1.5.11-alpha.39

3 years ago

1.5.10

3 years ago

1.5.9

3 years ago

1.5.7

3 years ago

1.5.6

3 years ago

1.5.6-alpha.38

3 years ago

1.5.5

3 years ago

1.5.4

3 years ago

1.5.3-alpha.37

3 years ago

1.5.3

3 years ago

1.5.1

3 years ago

1.5.0

3 years ago

1.4.11

3 years ago

1.4.10

3 years ago

1.4.9

3 years ago

1.4.8

3 years ago

1.4.8-alpha.35

3 years ago

1.4.7-alpha.33

3 years ago

1.4.7

3 years ago

1.4.7-alpha.32

3 years ago

1.4.5

3 years ago

1.4.4

3 years ago

1.4.3

3 years ago

1.4.2

3 years ago

1.4.1

3 years ago

1.4.0

3 years ago

1.4.0-alpha.31

3 years ago

1.4.0-alpha.30

3 years ago

1.3.14

3 years ago

1.3.13

3 years ago

1.3.12

3 years ago

1.3.11-alpha.28

3 years ago

1.3.11

3 years ago

1.3.11-alpha.27

3 years ago

1.3.9

3 years ago

1.3.10

3 years ago

1.3.9-alpha.22

3 years ago

1.3.9-alpha.21

3 years ago

1.3.9-alpha.20

3 years ago

1.3.7

3 years ago

1.3.6

3 years ago

1.3.5

3 years ago

1.3.3-alpha.18

3 years ago

1.3.3-alpha.19

3 years ago

1.3.3

3 years ago

1.3.3-alpha.13

3 years ago

1.3.2-alpha.11

3 years ago

1.3.2

3 years ago

1.3.1-alpha.10

3 years ago

1.3.1

3 years ago

1.3.0

3 years ago

1.3.0-alpha.9

4 years ago

1.3.0-alpha.6

4 years ago

1.3.0-alpha.7

4 years ago

1.3.0-alpha.5

4 years ago

1.2.19

4 years ago

1.2.17

4 years ago

1.2.16

4 years ago

1.2.15

4 years ago

1.2.14

4 years ago

1.2.13

4 years ago

1.2.12

4 years ago

1.2.8

4 years ago

1.2.7

4 years ago

1.2.6

4 years ago

1.2.5

4 years ago

1.2.4

4 years ago

1.2.3

4 years ago

1.2.2

4 years ago

1.2.1

4 years ago

1.2.0

4 years ago

1.1.18

4 years ago

1.1.16

4 years ago

1.1.15

4 years ago

1.1.14

4 years ago

1.1.13

4 years ago

1.1.12

4 years ago

1.1.11

4 years ago

1.1.10

4 years ago

1.1.9

4 years ago

1.1.7

4 years ago

1.1.6

4 years ago

1.1.5

4 years ago

1.1.4

4 years ago

1.1.2

4 years ago

1.1.1

4 years ago

1.1.0

4 years ago

1.0.27

4 years ago

1.0.26

4 years ago

1.0.25

4 years ago

1.0.24

4 years ago

1.0.23

4 years ago

1.0.22

4 years ago

1.0.20

4 years ago

1.0.19

4 years ago

1.0.18

4 years ago

1.0.17

4 years ago

1.0.16

4 years ago

1.0.15

4 years ago

1.0.14

4 years ago

1.0.12

4 years ago

1.0.10

4 years ago

1.0.9

4 years ago

1.0.8

4 years ago

1.0.7

4 years ago

1.0.6

4 years ago

1.0.4

4 years ago

1.0.3

4 years ago

1.0.0

4 years ago

0.11.27

4 years ago

0.11.26

4 years ago

0.11.24

4 years ago

0.11.25

4 years ago

0.11.23

4 years ago

0.11.22

4 years ago

0.11.21

4 years ago

0.11.20

4 years ago

0.11.18

4 years ago

0.11.17

4 years ago

0.11.16

4 years ago

0.11.15

4 years ago

0.11.14

4 years ago

0.11.12

4 years ago

0.11.13

4 years ago

0.11.11

4 years ago

0.11.10

4 years ago

0.11.9

4 years ago

0.11.8

4 years ago

0.11.7

4 years ago

0.11.6

5 years ago

0.11.5

5 years ago

0.11.3

5 years ago

0.11.2

5 years ago

0.11.1

5 years ago

0.11.0

5 years ago

0.10.10

5 years ago

0.10.9

5 years ago

0.10.5

5 years ago

0.10.4

5 years ago

0.10.3

5 years ago

0.10.2

5 years ago

0.10.1

5 years ago

0.10.0

5 years ago

0.9.40

5 years ago

0.9.39

5 years ago

0.9.32

5 years ago

0.9.31

5 years ago

0.9.30

5 years ago

0.9.29

5 years ago

0.9.28

5 years ago

0.9.27

5 years ago

0.9.26

5 years ago

0.9.25

5 years ago

0.9.24

5 years ago

0.9.23

5 years ago

0.9.22

5 years ago

0.9.21

5 years ago

0.9.20

5 years ago

0.9.19

5 years ago

0.9.18

5 years ago

0.9.17

5 years ago

0.9.16

5 years ago

0.9.15

5 years ago

0.9.14

5 years ago