JavaScript/TypeScript Client for MagX multiplayer game server.
npm install --save magx-client
and include it to your project
import { Client } from "magx-client"
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/magx.js"></script>
or you can include magx-client package to server dependencies and use it on client:
<script src="/magx"></script>
var client = new MagX.Client({ address: "localhost", port: 3001, secure: true })
// Authenticate
await client.authenticate({ login, password })
// or verify your session
await client.verify(token)
// Get avaliable rooms
const rooms = await client.getRooms("lobby")
// create new room
const room = await client.createRoom(name, params)
// or join to existing room
const room = await client.joinRoom(roomId, params)
// or reconnect to room
const room = await client.reconnect(roomId)
// new room state
room.onSnapshot((state) => {
console.log("initial room state:", state)
})
// listen to patches coming from the server
room.onPatch((patch) => {
// this signal is triggered on each patch
console.log("room state patch:", patch)
})
// listen to messages coming from the server
room.onMessage("move", (data) => {
// this signal is triggered on each "move" message
console.log("new move message:", data)
})
// listen to specified state changes
room.onChange("replace", "object/:id/*", (patch, { id }) => updateObject(id, patch))
// short alias for onChange event
room.onAdd("players/:id", (patch, { id }) => addPlayer(id, patch.value)
room.onRemove("players/:id", (patch, { id }) => removePlayer(id))
room.onReplace("players/:id/:prop", (patch, { id, prop }) => updatePlayer(id, prop, patch.value))
// server error occurred
room.onError((code, message) => {
console.log("error", code, message);
})
// client left the room
room.onLeave(() => {
console.log(client.id, "left");
})
// send message
room.send(type, data)
// leave room
room.leave()
// close room
room.close() {
// update room params
room.update(update)
The easiest way to try out magx-client is using the magx-example:
git clone https://github.com/udamir/magx-examples.git
cd magx-examples
npm install
To run the MagX server, run npm start