Client-side Playground is now available!

[endel]

playground.mp4

How to test it

The playground tool is installed by default on new projects created via npm create colyseus-app.

To manually install on an existing project, please do:

npm install --save @colyseus/playground

Then, import and bind it to your express app instance:

// import the route
import { playground } from "@colyseus/playground";

// bind it as an express middleware
app.use("/playground", playground);

Your feedback is welcome!

Is there a feature you'd like to see, or an improvement that would make your life easier inspecting/debugging your room implementation?

[BugSlayer87]

Awesome to found this Client-side Playground is now available.
Is there any requirement for using this ?
Because in my colyseus version 0.14 its error

[endel]

Hi @BugSlayer87, it only works on version 0.15

[pastean]

I was under the impression that this would also show existing rooms, or is this designed with another goal in mind?

[avatus]

You can use https://github.com/colyseus/colyseus-monitor to inspect existing rooms, including state. Playground (from what I understand) is more of a way to test interactions from a client <-> room

[vinkent420]

Thank @avatus , you helped me a lots. I saw state tab now in monitor. But don't know how to keep that state when user (player) join room again, ex. last position in map to render exactly.

And I tried to deploy Colyseus server on GCP K8s, when I deploy again, I see the room was disposing (delete in my MongoDB) -> so user will createNewRoom by RoomName, don't know if we have ways to solve this.

Many thank @avatus @endel so so much, so appreciate!

[Yashko]

Hello! I'm playing around with Colyseus and I like it so far. Is there a way to share state only partially with a client? Let's say I have Room with locations that needed to be actually reached before client would be able to see what items in there

[Yashko]

@endel

[endel]

Hi @Yashko, thanks for your interest - right now partial state sync is only supported via the @filter()/@filterChildren(), which has some limitations and I do not recommend using for anything other than turn-based games as it consumes too much CPU.

A new "data ownership" model is on the roadmap as part of improvements on the state sync structures - though no progress has been made there yet https://github.com/colyseus/colyseus/wiki/Public-Roadmap#colyseus-framework

[beiryu]

Hi @endel ,

Recently, I have been using colyseus/colyseus as a game server and colyseus/playground to test messages between client-room-server.

Displaying schemas is a necessary feature to allow clients (game clients) to know which properties they will use in the schema to make requests and receive corresponding responses.

I want to use my code to contribute to the colyseus/playground repository. For those who might want to use a similar feature in the future.

Currently, I have only created a pull request here, you can review the code and the attached image.

If possible, please let me know the process for contributing to the colyseus/playground repository, including code conventions, etc. I will follow them.

Thanks,

[huseyindeniz]

hi @endel , thanks for the playground repo, and quick feedback for the last version:

I think typescript definition is missing in the latest version (0.15.16). There is no index.d.ts file under the build dir anymore. I also can't find any types package for this playground package. VS Code is suggesting to install npm i --save-dev @types/colyseus__playground but obviously that package is not exist.

(Issues tab is not active in the playground repo btw, so I can't report it there.)

[endel]

Hi @huseyindeniz, thank you for the detailed report. I just published version 0.15.17 fixing this. (Some of the repo's Issues tab have been disabled so we can use the main "colyseus" repo for all of them...)