@dcl/protocol 1.0.0-3227242807.commit-ad14cba → 1.0.0-3237582415.commit-28fe6ac

package/proto/decentraland/kernel/comms/v1/comms.proto

@@ -0,0 +1,68 @@
+syntax = "proto3";
+
+package decentraland.kernel.comms.v1;
+
+message AuthData {
+  string signature = 1;
+  string identity = 2;
+  string timestamp = 3;
+  string access_token = 4;
+}
+
+enum Category {
+  C_UNKNOWN = 0;
+  C_POSITION = 1;
+  C_PROFILE = 2;
+  C_CHAT = 3;
+  C_SCENE_MESSAGE = 4;
+  C_PROF_REQ = 5;
+  C_PROF_RES = 6;
+}
+
+message DataHeader {
+  Category category = 1;
+}
+
+message PositionData {
+  Category category = 1;
+  double time = 2;
+  float position_x = 3;
+  float position_y = 4;
+  float position_z = 5;
+  float rotation_x = 6;
+  float rotation_y = 7;
+  float rotation_z = 8;
+  float rotation_w = 9;
+  bool immediate = 10;
+}
+
+message ProfileData {
+  Category category = 1;
+  double time = 2;
+  string profile_version = 3;
+  enum ProfileType {
+    PT_LOCAL = 0;
+    PT_DEPLOYED = 1;
+  }
+  ProfileType profile_type = 4;
+}
+
+message ProfileRequestData {
+  Category category = 1;
+  double time = 2;
+  string profile_version = 3;
+  string user_id = 4;
+}
+
+message ProfileResponseData {
+  Category category = 1;
+  double time = 2;
+  string serialized_profile = 3;
+}
+
+message ChatData {
+  Category category = 1;
+  double time = 2;
+  string message_id = 3;
+  string text = 4;
+}

package/proto/decentraland/kernel/comms/v2/comms.proto

@@ -0,0 +1,61 @@
+syntax = "proto3";
+
+package decentraland.kernel.comms.v2;
+
+message CommsMessage {
+  double time = 1;
+  oneof data {
+    PositionData position_data = 2;
+    ProfileData profile_data = 3;
+    ChatData chat_data = 4;
+    SceneData scene_data = 5;
+    VoiceData voice_data = 6;
+    ProfileRequestData profile_request_data = 7;
+    ProfileResponseData profile_response_data = 8;
+  }
+}
+
+message PositionData {
+  float position_x = 1;
+  float position_y = 2;
+  float position_z = 3;
+  float rotation_x = 4;
+  float rotation_y = 5;
+  float rotation_z = 6;
+  float rotation_w = 7;
+  bool immediate = 8;
+}
+
+message ProfileData {
+  string profile_version = 1;
+  string user_id = 2;
+  enum ProfileType {
+    PT_DEPLOYED = 0;
+    PT_LOCAL = 1;
+  }
+  ProfileType profile_type = 3;
+}
+
+message ProfileRequestData {
+  string profile_version = 1;
+  string user_id = 2;
+}
+
+message ProfileResponseData {
+  string serialized_profile = 1;
+}
+
+message ChatData {
+  string message_id = 1;
+  string text = 2;
+}
+
+message SceneData {
+  string scene_id = 1;
+  string text = 2;
+}
+
+message VoiceData {
+  bytes encoded_samples = 1;
+  uint32 index = 2;
+}

package/{kernel → proto/decentraland/kernel}/comms/v3/archipelago.proto

@@ -1,10 +1,10 @@
 syntax = "proto3";
 
-package protocol.comms.v3;
+package decentraland.kernel.comms.v3;
 
 enum TransportType {
-  TRANSPORT_LIVEKIT = 0;
-  TRANSPORT_WS = 1;
+  TT_LIVEKIT = 0;
+  TT_WS = 1;
 }
 
 message Position3DMessage {
@@ -17,7 +17,7 @@ message IslandChangedMessage {
   string island_id = 1;
   string conn_str = 2;
   optional string from_island_id = 3;
-  map<string, Position3DMessage>  peers = 4;
+  map<string, Position3DMessage> peers = 4;
 }
 
 message LeftIslandMessage {
@@ -33,7 +33,7 @@ message JoinIslandMessage {
 message IslandData {
   string id = 1;
   repeated string peers = 2;
-  uint32 maxPeers = 3;
+  uint32 max_peers = 3;
   Position3DMessage center = 4;
   double radius = 5;
 }
@@ -67,7 +67,7 @@ message TransportMessage {
   oneof message {
     TransportInit init = 1;
     TransportHeartbeat heartbeat = 2;
-    TransportAuthorizationRequest authRequest = 3;
-    TransportAuthorizationResponse authResponse = 4;
+    TransportAuthorizationRequest auth_request = 3;
+    TransportAuthorizationResponse auth_response = 4;
   }
 }

package/{kernel → proto/decentraland/kernel}/comms/v3/comms.proto

@@ -1,6 +1,6 @@
 syntax = "proto3";
 
-package protocol.comms.v3;
+package decentraland.kernel.comms.v3;
 
 message Position {
     double time = 2;
@@ -17,8 +17,8 @@ message Profile {
     double time = 2;
     string profile_version = 3;
     enum ProfileType {
-        LOCAL = 0;
-        DEPLOYED = 1;
+        PT_LOCAL = 0;
+        PT_DEPLOYED = 1;
     }
     ProfileType profile_type = 4;
 }

package/{renderer-protocol/EngineInterface.proto → proto/decentraland/renderer/engine_interface.proto}

@@ -3,11 +3,11 @@
 
 syntax = "proto3";
 
-package engineinterface;
+package decentraland.renderer;
 
 import "google/protobuf/empty.proto";
 
-option csharp_namespace = "DCL.Interface";
+// option csharp_namespace = "DCL.Interface";
 
 message PB_CreateEntity {
     string id = 1;

package/{renderer-protocol/RendererProtocol.proto → proto/decentraland/renderer/protocol.proto}

@@ -1,5 +1,7 @@
 syntax = "proto3";
 
+package decentraland.renderer;
+
 message CRDTManyMessages {
   string scene_id = 1;
   bytes	payload = 2;

package/{ecs → proto/decentraland/sdk}/components/README.md

@@ -6,8 +6,8 @@ Inside each proto, we need to have at least this template:
 ```proto
 syntax = "proto3";
 
-import "ecs/components/common/id.proto";
-option (ecs_component_id) = XXXX;
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = XXXX;
 
 message PBComponentName {
     float one_parameter = 1;
@@ -22,7 +22,7 @@ Some points that must be well-defined:
 
 
 ## Common directory
-The common directory only has to have unambiguous structures like Vector3, Color3, Quaternion, etc. These messages will never change.
+The common directory only has to have unambiguous structures like decentraland.common.Vector3, decentraland.common.Color3, Quaternion, etc. These messages will never change.
 
 ## About specific options with other languages
 The definition must be the minimal proto code, and it shouldn't have a specific option to compile on some platform. So if you have to add additional information to the proto, you will be able to run a post-process after the protocol schemas acquisition.

package/{ecs/components/Animator.proto → proto/decentraland/sdk/components/animator.proto}

@@ -1,7 +1,8 @@
 syntax = "proto3";
+package decentraland.sdk.components;
 
-import "ecs/components/common/id.proto";
-option (ecs_component_id) = 1042;
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1042;
 
 message PBAnimator {
    repeated PBAnimationState states = 1;

package/{ecs/components/AudioSource.proto → proto/decentraland/sdk/components/audio_source.proto}

@@ -1,7 +1,8 @@
 syntax = "proto3";
+package decentraland.sdk.components;
 
-import "ecs/components/common/id.proto";
-option (ecs_component_id) = 1020;
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1020;
 
 message PBAudioSource {  
   optional bool playing = 1;

package/{ecs/components/AudioStream.proto → proto/decentraland/sdk/components/audio_stream.proto}

@@ -1,7 +1,8 @@
 syntax = "proto3";
+package decentraland.sdk.components;
 
-import "ecs/components/common/id.proto";
-option (ecs_component_id) = 1021;
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1021;
 
 message PBAudioStream {  
   optional bool playing = 1;

package/proto/decentraland/sdk/components/avatar_attach.proto

@@ -0,0 +1,19 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+
+option (common.ecs_component_id) = 1073;
+
+enum AvatarAnchorPoint {
+  AAP_POSITION = 0;
+  AAP_NAME_TAG = 1;
+  AAP_LEFT_HAND = 2;
+  AAP_RIGHT_HAND = 3;
+}
+
+message PBAvatarAttach {
+  string avatar_id = 1;
+  AvatarAnchorPoint anchor_point_id = 2;
+}

package/proto/decentraland/sdk/components/avatar_modifier_area.proto

@@ -0,0 +1,19 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/common/vectors.proto";
+import "decentraland/sdk/components/common/id.proto";
+
+option (common.ecs_component_id) = 1070;
+
+enum AvatarModifier {
+  AM_HIDE_AVATARS = 0;
+  AM_DISABLE_PASSPORTS = 1;
+}
+
+message PBAvatarModifierArea {
+  decentraland.common.Vector3 area = 1;
+  repeated string exclude_ids = 2;
+  repeated AvatarModifier modifiers = 3;
+}

package/{ecs/components/AvatarShape.proto → proto/decentraland/sdk/components/avatar_shape.proto}

@@ -1,16 +1,17 @@
 syntax = "proto3";
+package decentraland.sdk.components;
 
-import "ecs/components/common/id.proto";
-option (ecs_component_id) = 1080;
-import "ecs/components/common/Color3.proto";
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1080;
+import "decentraland/common/colors.proto";
 
 message PBAvatarShape {
   string id = 1;
   optional string name = 2; // default = NPC
   optional string body_shape = 3; // default = urn:decentraland:off-chain:base-avatars:BaseFemale
-  optional Color3 skin_color = 4; // default = Color3(R = 0.6f, G = 0.462f, B = 0.356f)
-  optional Color3 hair_color = 5; // default = Color3(R = 0.283f, G = 0.142f, B = 0f)
-  optional Color3 eye_color = 6; // default = Color3(R = 0.6f, G = 0.462f, B = 0.356f)
+  optional decentraland.common.Color3 skin_color = 4; // default = decentraland.common.Color3(R = 0.6f, G = 0.462f, B = 0.356f)
+  optional decentraland.common.Color3 hair_color = 5; // default = decentraland.common.Color3(R = 0.283f, G = 0.142f, B = 0f)
+  optional decentraland.common.Color3 eye_color = 6; // default = decentraland.common.Color3(R = 0.6f, G = 0.462f, B = 0.356f)
   optional string expression_trigger_id = 7;
   optional int64 expression_trigger_timestamp = 8; // default = timestamp
   optional bool talking = 9;

package/{ecs/components/Billboard.proto → proto/decentraland/sdk/components/billboard.proto}

@@ -1,7 +1,8 @@
 syntax = "proto3";
+package decentraland.sdk.components;
 
-import "ecs/components/common/id.proto";
-option (ecs_component_id) = 1090;
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1090;
 
 message PBBillboard {
   optional bool x = 1; // default=true

package/proto/decentraland/sdk/components/camera_mode.proto

@@ -0,0 +1,10 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1072;
+import "decentraland/sdk/components/common/camera_mode_value.proto";
+
+message PBCameraMode {
+  common.CameraModeValue mode = 1;
+}

package/proto/decentraland/sdk/components/camera_mode_area.proto

@@ -0,0 +1,12 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1071;
+import "decentraland/common/vectors.proto";
+import "decentraland/sdk/components/common/camera_mode_value.proto";
+
+message PBCameraModeArea {
+  decentraland.common.Vector3 area = 1;
+  common.CameraModeValue mode = 2;
+}

package/proto/decentraland/sdk/components/common/action_button.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+
+package decentraland.sdk.components.common;
+
+enum ActionButton {
+  AB_POINTER = 0;
+  AB_PRIMARY = 1;
+  AB_SECONDARY = 2;
+  AB_ANY = 3;
+  AB_FORWARD = 4;
+  AB_BACKWARD = 5;
+  AB_RIGHT = 6;
+  AB_LEFT = 7;
+  AB_JUMP = 8;
+  AB_WALK = 9;
+  AB_ACTION_3 = 10;
+  AB_ACTION_4 = 11;
+  AB_ACTION_5 = 12;
+  AB_ACTION_6 = 13;
+}

package/proto/decentraland/sdk/components/common/camera_mode_value.proto

@@ -0,0 +1,8 @@
+syntax = "proto3";
+
+package decentraland.sdk.components.common;
+
+enum CameraModeValue {
+  CMV_FIRST_PERSON = 0;
+  CMV_THIRD_PERSON = 1;
+}

package/{ecs → proto/decentraland/sdk}/components/common/id.proto

@@ -1,4 +1,5 @@
 syntax = "proto3";
+package decentraland.sdk.components.common;
 
 import "google/protobuf/descriptor.proto";
 

package/proto/decentraland/sdk/components/common/texts.proto

@@ -0,0 +1,14 @@
+syntax = "proto3";
+
+package decentraland.sdk.components.common;
+
+enum TextAlign {
+  TA_CENTER = 0;
+  TA_LEFT = 1;
+  TA_RIGHT = 2;
+}
+
+enum Font {
+  F_LIBERATION_SANS = 0;
+  F_SANS_SERIF = 1;
+}

package/{ecs/components/GltfContainer.proto → proto/decentraland/sdk/components/gltf_container.proto}

@@ -1,7 +1,8 @@
 syntax = "proto3";
+package decentraland.sdk.components;
 
-import "ecs/components/common/id.proto";
-option (ecs_component_id) = 1041;
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1041;
 
 message PBGltfContainer {
    // which file to load

package/proto/decentraland/sdk/components/material.proto

@@ -0,0 +1,59 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/common/colors.proto";
+import "decentraland/sdk/components/common/id.proto";
+
+option (common.ecs_component_id) = 1017;
+
+enum TextureWrapMode {
+  TWM_REPEAT = 0;
+  TWM_CLAMP = 1;
+  TWM_MIRROR = 2;
+  TWM_MIRROR_ONCE = 3;
+}
+
+enum FilterMode {
+  FM_POINT = 0;
+  FM_BILINEAR = 1;
+  FM_TRILINEAR = 2;
+}
+
+enum TransparencyMode {
+  TM_OPAQUE = 0;
+  TM_ALPHA_TEST = 1;
+  TM_ALPHA_BLEND = 2;
+  TM_ALPHA_TEST_AND_ALPHA_BLEND = 3;
+  TM_AUTO = 4;
+}
+
+message PBMaterial {
+  message Texture {
+    string src = 1;
+    optional TextureWrapMode wrap_mode = 2; // default = TextureWrapMode.Clamp
+    optional FilterMode filter_mode = 3; // default = FilterMode.Bilinear
+  }
+
+  optional Texture texture = 1; // default = null
+  optional float alpha_test = 2; // default = 0.5. range value: from 0 to 1
+  optional bool cast_shadows = 3; // default =  true
+
+  optional Texture alpha_texture = 4; // default = null
+  optional Texture emissive_texture = 5; // default = null
+  optional Texture bump_texture = 6; // default = null
+
+  optional decentraland.common.Color3 albedo_color = 7; // default = white;
+  optional decentraland.common.Color3 emissive_color = 8; // default = black;
+  optional decentraland.common.Color3 reflectivity_color = 9; // default = white;
+
+  optional TransparencyMode transparency_mode = 10; // default = TransparencyMode.Auto
+
+  optional float metallic = 11; // default = 0.5
+  optional float roughness = 12; // default = 0.5
+  optional float glossiness = 13; // default = 1
+
+  optional float specular_intensity = 14; // default = 1
+  optional float emissive_intensity = 15; // default = 2
+  optional float direct_intensity = 16; // default = 1
+}

package/proto/decentraland/sdk/components/mesh_collider.proto

@@ -0,0 +1,35 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+
+option (common.ecs_component_id) = 1019;
+
+enum ColliderLayer {
+  CL_NONE = 0;
+  CL_POINTER = 1;
+  CL_PHYSICS = 2;
+}
+
+message PBMeshCollider {
+  message BoxMesh {}
+
+  message CylinderMesh {
+    optional float radius_top = 1; // default=1.0
+    optional float radius_bottom = 2; // default=1.0
+  }
+
+  message PlaneMesh {}
+
+  message SphereMesh {}
+
+  optional int32 collision_mask = 1; // default = ColliderLayer.Physics | ColliderLayer.Pointer
+
+  oneof mesh {
+    BoxMesh box = 2;
+    SphereMesh sphere = 3;
+    CylinderMesh cylinder = 4;
+    PlaneMesh plane = 5;
+  }
+}

package/{ecs/components/MeshRenderer.proto → proto/decentraland/sdk/components/mesh_renderer.proto}

@@ -1,7 +1,8 @@
 syntax = "proto3";
+package decentraland.sdk.components;
 
-import "ecs/components/common/id.proto";
-option (ecs_component_id) = 1018;
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1018;
 
 message PBMeshRenderer {
     message BoxMesh {

package/proto/decentraland/sdk/components/nft_shape.proto

@@ -0,0 +1,40 @@
+syntax = "proto3";
+
+package decentraland.sdk.components;
+
+import "decentraland/common/colors.proto";
+import "decentraland/sdk/components/common/id.proto";
+
+option (common.ecs_component_id) = 1040;
+
+enum PictureFrameStyle {
+  PFS_CLASSIC = 0;
+  PFS_BAROQUE_ORNAMENT = 1;
+  PFS_DIAMOND_ORNAMENT = 2;
+  PFS_MINIMAL_WIDE = 3;
+  PFS_MINIMAL_GREY = 4;
+  PFS_BLOCKY = 5;
+  PFS_GOLD_EDGES = 6;
+  PFS_GOLD_CARVED = 7;
+  PFS_GOLD_WIDE = 8;
+  PFS_GOLD_ROUNDED = 9;
+  PFS_METAL_MEDIUM = 10;
+  PFS_METAL_WIDE = 11;
+  PFS_METAL_SLIM = 12;
+  PFS_METAL_ROUNDED = 13;
+  PFS_PINS = 14;
+  PFS_MINIMAL_BLACK = 15;
+  PFS_MINIMAL_WHITE = 16;
+  PFS_TAPE = 17;
+  PFS_WOOD_SLIM = 18;
+  PFS_WOOD_WIDE = 19;
+  PFS_WOOD_TWIGS = 20;
+  PFS_CANVAS = 21;
+  PFS_NONE = 22;
+}
+
+message PBNFTShape {
+  string src = 1;
+  optional PictureFrameStyle style = 2; // default = PictureFrameStyle.Classic
+  optional decentraland.common.Color3 color = 3; // default = decentraland.common.Color3(0.6404918, 0.611472, 0.8584906)
+}

package/proto/decentraland/sdk/components/pointer_events.proto

@@ -0,0 +1,29 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1062;
+import "decentraland/sdk/components/common/action_button.proto";
+
+enum PointerEventType {
+  PET_UP = 0;
+  PET_DOWN = 1;
+  PET_HOVER_ENTER = 2;
+  PET_HOVER_LEAVE = 3;
+}
+
+message PBPointerEvents {
+  message Info {
+    optional common.ActionButton button = 1; // default=ActionButton.ANY
+    optional string hover_text = 2; // default='Interact'
+    optional float max_distance = 3; // default=10
+    optional bool show_feedback = 4; // default=true
+  }
+
+  message Entry {
+    PointerEventType event_type = 1;
+    Info event_info = 2;
+  }
+
+  repeated Entry pointer_events = 1;
+}

package/{ecs/components/PointerEventsResult.proto → proto/decentraland/sdk/components/pointer_events_result.proto}

@@ -1,10 +1,11 @@
 syntax = "proto3";
+package decentraland.sdk.components;
 
-import "ecs/components/common/id.proto";
-import "ecs/components/RaycastResult.proto";
-import "ecs/components/PointerEvents.proto";
-option (ecs_component_id) = 1063;
-import "ecs/components/common/ActionButton.proto";
+import "decentraland/sdk/components/common/id.proto";
+import "decentraland/sdk/components/raycast_result.proto";
+import "decentraland/sdk/components/pointer_events.proto";
+option (common.ecs_component_id) = 1063;
+import "decentraland/sdk/components/common/action_button.proto";
 
 // the renderer will set this component to the root entity once per frame with all the events
 message PBPointerEventsResult {
@@ -13,7 +14,7 @@ message PBPointerEventsResult {
 
   // this message represents a pointer event, used both for UP and DOWN actions
   message PointerCommand {
-    ActionButton button = 1; // identifier of the input
+    common.ActionButton button = 1; // identifier of the input
     RaycastHit hit = 2;
     PointerEventType state = 4;
     int32 timestamp = 5; // could be a Lamport timestamp

package/proto/decentraland/sdk/components/pointer_lock.proto

@@ -0,0 +1,9 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1074;
+
+message PBPointerLock {
+  bool is_pointer_locked = 1;
+}