Multiplay

zepeto multiplay is a module that allows multiple users to connect and play the world at the same time it provides the server/client development and local test environment 📘 official multiplay world sample github https //github com/naverz/zepeto multiplay example https //github com/naverz/zepeto multiplay example tutorial multiplay tutorial docid t5niungy1dinmcp5fka3 step 1 install select zepeto → multiplay server on the \[+] menu at the top left of the \[project] panel, or go to assets → create → zepeto → multiplay server the world multiplay package consists of the following items, and are automatically updated when the world is published index ts server main logic code schemas data structure for server/client communication ❗️ caution only one world multiplay package can be created per game step 2 settings click the \[open world settings] as shown in the image below to set the world setting property description version enter the version of your file to be registered maxclients set the maximum number of people who can access the room orientation choose the orientation of the screen disable invite disables room invitation function disable room list disables the ability to check the room list disable private room disables the ability to create a private room 👍 disable invite even if the room invitation function is off, you can send invites through the test link step 3 running a test server zepeto multiplay provides a local server environment where the creator can test servers/clients during development to check the local server actions, select unity top menu → window → zepeto → multiplay server to open the server status window click the server button next to the \[▶︎(play)] button at the center of the editor's screen you will see the following server log at the server status pane step 4 connecting to a client(connecting to a local server) the zepetoworldmultiplay component is a multiplay manager class used on the client side create a gameobject in the hierachy window, and add a zepetoworldmultiplay component the zepetoworldmultiplay component will automatically conect to the multiplay package click on the \[▶︎(play)] button at the center of the editor screen to view the client connection log in the server log window the development server runs on localhost(127 0 0 1), and the port is set when the project is first loaded when connecting through multi project, set the connection environment to the following 📘 please refer to the following guide accessing to multiplay ip addresses docid\ dzwfsz5hw7z r8nkcge h 👍 after the world is distributed, it will run on the zepeto server step 5 server / client communication default example implementing server logic the index ts file in the world multiplay package is the code responsible for the server's main logic open the index ts file, and add the logic that is delivered to the client after receiving the message type, echo, in the oncreate() event 📘 please refer to the following guide \[zepeto multiplay(server) api] import { sandbox, sandboxoptions, sandboxplayer } from 'zepeto multiplay'; import { player } from 'zepeto multiplay schema'; export default class extends sandbox { oncreate(options sandboxoptions) { this onmessage("echo", (client, message) => { console log(`echo onmessage from ${client sessionid}, > ${message}`); // send current client client send("echo", "echo to sender " + message); // broadcast all connected client this broadcast("echo", "echo to all " + message); }); } onjoin(client sandboxplayer) { const player = new player(); player sessionid = client sessionid; player userid = client userid; const players = this state players; players set(client sessionid, player); console log('onjoin!!!!'); } onleave(client sandboxplayer, consented? boolean) { } } implementing client logic create an add the zepeto script in the zepetoworldmultiplay gameobject used to send/receive server events as follows multiplaysample ts import { zepetoscriptbehaviour } from 'zepeto script'; import { zepetoworldmultiplay } from 'zepeto world'; import { room } from 'zepeto multiplay'; export default class multiplaysample extends zepetoscriptbehaviour { private multiplay zepetoworldmultiplay; start() { this multiplay = this gameobject getcomponent\<zepetoworldmultiplay>(); this multiplay roomjoined += (room room) => { console log(`roomcreated, my session id is ${room sessionid}`); // send message to server room send("echo", "hello zepeto multiplay"); // add server message listener room addmessagehandler("echo", (message) => { // print server message console log(message); }); }; } } 📘 please refer to the following guide multiplay room message docid\ a04weva7 xyk k al0kzk step 6 test output results click the \[▶︎(play)] on the center of the editor screen to run the server/client you should see an example of an 'echo' type message as shown below ① log of the output when client messages are received in the server ② log of the message received from the server from the client precautions when using server code ❗️ caution \[use of variables within server code] variables can also be declared in server code however, the cache memory available in the server is currently limited to 512kb (this may change later ) if it exceeds 512kb, the room may be hidden, so please develop it with this in mind \[use of loops within server code] the loop time limit is set to 2 seconds (2000ms) in the server code please consider this when developing, as using blocking code or long running loops may cause the program to fail to execute correctly due to the loop time limit