rooms agent

[drunkplato]

This is a first pass at defining the rooms structure and types.

::  sur/rooms.hoon
::  Defines the types for the webrtc rooms in Realm.

/-  membership, spaces
|%
:: 
::  we may handle the participant status via webrtc only
::
::
+$  participants   (set ship)
+$  room-access    ?(%public %private)
+$  room
  $:  id=@t                 ::  hashed value used for unique room
      title=cord            ::  the title of the room
      host=space-type       ::  who the host is
      access=room-access    ::  is this room publicly shared or private invites
      =participants         ::  
  ==

+$  space-rooms     (map space-path:spaces room)
::
::  Poke actions
::  
::  %create: a host creates a room
::  %join: a ship joins a room (should check if invited depending on access)
::  %leave: a ship leave a room (should end the room if the host leaves)
::  %kick: only the host can kick a ship from the room
::
+$  action
  $%  [%create path=space-path:spaces payload=room-add]
      [%join path=space-path:spaces id=@t]
      [%leave path=space-path:spaces id=@t] 
      [%kick path=space-path:spaces id=@t participant=ship]
  ==
::
+$  room-add
  $:  title=space-name
      host=space-type
      access=room-access
      =participants
  ==
::
::  Reaction via watch paths
::
+$  reaction
  $%  [%initial path=space-path:spaces =space-rooms]
      [%room-added path=space-path:spaces =room]
      [%room-ended path=space-path:spaces id=@t]
      [%participant-joined path=space-path id=@t participant=ship]
      [%participant-left path=space-path id=@t participant=ship]
      [%participant-kicked path=space-path id=@t participant=ship]
  ==
--

[drunkplato]

Bringing this from an older issue:

Room: Each Realm shared desktop space can have many rooms (i.e. Discord Server:Voice Channel, Realm Desktop:Room). This concept is visible to end users in the taskbar.

Channel: A channel limits whose cursors you're seeing/which clients you're sending events to. This allows developers to control which users are seeing each others cursors, e.g. a whiteboarding app has separate canvases that have their own channels. Mostly invisible to end users and managed by the developers/Realm.

• MyDAO Work Room (2/5 here)
  • Whiteboard App: Brainstorm Board Channel (2 here)
  • Writing App: Roadmap 2022 Channel (1 here)

Ideas

• https://liveblocks.io/
• https://prosemirror.net/examples/collab/#edit-Example
• https://www.radix-ui.com/docs/primitives/overview/introduction

Reference the realm/multiplayer wiki

[bacwyls]

https://github.com/holium/realm/tree/rooms-agents