Preparations

Required changes

If you download the sample code, be sure to change the channelKey value. You can check the part to be changed through the explanation below and change it.

Unity SDK 💾

1. Copy the Channel Key of the chat room created in the CMS screen.
2. Create an empty 3D project in Unity Hub using Unity SDK.
3. Use the Package Manager to add the following Git repository: https://github.com/PimDeWitte/UnityMainThreadDispatcher.git.
4. Use the Package Manager to add the following Git repository: https://github.com/e7works-git/vchatcloud-unity-sample.git.
5. Copy the contents under /Runtime in the added VChatCloudUnitySDK package and add them to Assets.
6. Open the Asset/Plugins/UnityVChat.cs file and paste the key copied from step 1 into the room_id variable. Set a nick_name to use in the chat room for the nick_name variable.

private async Task ConnectAndJoinRoomAsync()
{

    room_id = "NpWXoXqzSG-ofk6E5p1xA-20240716140303";
    nick_name = "U-User";

vchatcloud object

vchatcloud class

A VChatCloud instance can be called as a singleton.

VChatCloud.getInstance()

channel method declaration

The channel method is implemented in the vchatCloud instance. Using the channel method, you can enter a chat room and control message events. The code below only covers entering a chat room. For detailed explanations on message sending, announcements, and other events, please refer to the Messages section in the left menu list.

channel = VChatCloud.GetInstance().JoinChannel(options, new JoinChannelCallbackImpl((history, e) =>
{
 
}));
 
channel.SetHandler(new MessageHandlerEx(this));

• Parameter values ​​(options)

  value	identifier	Description
  ChannelKey	String	Channel Key issued after creating a chat room
  ClientKey	String	Unique key for access terminal setting
  NickName	String	Nickname of the user entering the chat room
  UserInfo	String	User profile information

• result value

  -error

  value	identifier	Description
  code	String	error code
  type	String	error type
  message	String	error message

  -history

  value	identifier	Description
  logType	String	log type
  roomId	String	Channel Key issued after creating a chat room
  clientKey	String	Unique key for access terminal setting
  message	String	message contents
  mimeType	String	message type (text: plain text, emoji: emoji)
  messageType	String	In case of empty value, general message, notice: "notice"
  nickName	String	Nickname of the user entering the chat room
  date	String	Transit time
  grade	String	User Rating