Merge branch 'protocol-squad' into pointer_position_and_drag

Author: robtfm

Makefile

@@ -24,4 +24,10 @@ all: buf-lint buf-build test
 install:
 	npm i
 	rm -rf proto/google || true
-	cp -r node_modules/protobufjs/google proto/google
+	cp -r node_modules/protobufjs/google proto/google
+
+list-components-ids:
+	@bash scripts/list-components-ids.sh
+
+check-component-id:
+	@bash scripts/check-component-id.sh $(ID)

proto/decentraland/common/texture.proto

@@ -1,5 +1,6 @@
 syntax = "proto3";
 package decentraland.common;
+import "decentraland/common/vectors.proto";
 
 enum TextureWrapMode {
   TWM_REPEAT = 0;
@@ -17,6 +18,10 @@ message Texture {
   string src = 1;
   optional TextureWrapMode wrap_mode = 2; // default = TextureWrapMode.Clamp
   optional TextureFilterMode filter_mode = 3; // default = FilterMode.Bilinear
+
+  // Final uv = offset + (input_uv * tiling)
+  optional Vector2 offset = 4; // default = Vector2.Zero; Offset for texture positioning, only works for the texture property in PbrMaterial or UnlitMaterial.
+  optional Vector2 tiling = 5; // default = Vector2.One; Tiling multiplier for texture repetition, only works for the texture property in PbrMaterial or UnlitMaterial.
 }
 
 message AvatarTexture {
@@ -31,10 +36,17 @@ message VideoTexture {
   optional TextureFilterMode filter_mode = 3; // default = FilterMode.Bilinear
 }
 
+message UiCanvasTexture {
+  uint32 ui_canvas_entity = 1;
+  optional TextureWrapMode wrap_mode = 2; // default = TextureWrapMode.Clamp
+  optional TextureFilterMode filter_mode = 3; // default = FilterMode.Bilinear
+}
+
 message TextureUnion {
   oneof tex {
     Texture texture = 1; // default = null
     AvatarTexture avatar_texture = 2; // default = null
     VideoTexture video_texture = 3; // default = null
+    UiCanvasTexture ui_texture = 4;
   }
-}
+}

proto/decentraland/kernel/comms/rfc4/comms.proto

@@ -17,6 +17,7 @@ message Packet {
     Movement movement = 8;
     PlayerEmote player_emote = 9;
     SceneEmote scene_emote = 10;
+    MovementCompressed movement_compressed = 12;
   }
   uint32 protocol_version = 11;
 }
@@ -56,6 +57,13 @@ message Movement {
   bool is_falling = 14;
 
   bool is_stunned = 15;
+  
+  float rotation_y = 16;
+}
+
+message MovementCompressed {
+  int32 temporal_data = 1; // bit-compressed: timestamp + animations 
+  int64 movement_data = 2; // bit-compressed: position + velocity 
 }
 
 message PlayerEmote {

proto/decentraland/sdk/components/common/camera_transition.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+package decentraland.sdk.components.common;
+
+// Defines the transition used towards the camera that contains the CameraTransition.
+// This structure may be updated in the future to specify from/to entities and to have easing functions.
+message CameraTransition {
+  oneof transition_mode {
+    float time = 1;
+    float speed = 2; // meters per second; e.g. speed 1 -> 1 meter per second
+  }
+}

proto/decentraland/sdk/components/global_light.proto

@@ -0,0 +1,22 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/common/colors.proto";
+import "decentraland/common/vectors.proto";
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1206;
+
+// defines the global scene light settings. must be added to the scene root.
+// to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
+message PBGlobalLight {
+  // the direction the directional light shines in.
+  // default depends on time of day and explorer implementation
+  optional decentraland.common.Vector3 direction = 1;
+  // ambient light color
+  // default: White
+  optional decentraland.common.Color3 ambient_color = 2;
+  // ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
+  // default 1
+  optional float ambient_brightness = 3;
+}

proto/decentraland/sdk/components/gltf_node.proto

@@ -5,12 +5,12 @@ import "decentraland/sdk/components/common/id.proto";
 option (common.ecs_component_id) = 1200;
 
 // a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
-// This component must be added to a direct child of an entity with a PbGltfContainer component, or
+// This component must be added to a direct child of an entity with a PBGltfContainer component, or
 // to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
 // in the parent.
 // The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
 // 
-// The renderer will attach a PbGltfNodeState to the entity describing the state. Once the state is `GNS_READY`, 
+// The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`, 
 // - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
 // - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
 // - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
@@ -27,7 +27,7 @@ option (common.ecs_component_id) = 1200;
 // - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
 // - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
 //   used as a base, and any gltf features (e.g. occlusion maps) from the gtlf spec that the renderer supports but that are not exposed in the 
-//   PbMaterial will be maintained.
+//   PBMaterial will be maintained.
 //
 // The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible: 
 // - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and

proto/decentraland/sdk/components/input_modifier.proto

@@ -0,0 +1,20 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1078;
+
+message PBInputModifier {
+    // when a boolean = false (default) the message is ignored and doesn't consume bandwidth
+    message StandardInput {
+        optional bool disable_all = 1;
+        optional bool disable_walk = 2;
+        optional bool disable_jog = 3;
+        optional bool disable_run = 4;
+        optional bool disable_jump = 5;
+        optional bool disable_emote = 6;
+    }
+
+    oneof mode {
+        StandardInput standard = 1;
+    }
+}

proto/decentraland/sdk/components/light.proto

@@ -0,0 +1,42 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/common/colors.proto";
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1204;
+
+// defines a light source.
+// the world has a default directional light (like sunlight) which can be overridden by adding the light component to the scene root.
+// a PBGlobalLight component can also be added to the root to control the directional light direction.
+// point lights (lightbulbs) or spotlights can be created by attaching the light component to non-root entities.
+message PBLight {
+  // whether the light is on
+  // default true
+  optional bool enabled = 1;
+  // light brightness in lux (lumens/m^2). 
+  // 
+  // for global directional light, this applies as a constant value at all surfaces and distances (though the effect on the surface still depends on incidence angle).
+  // the default global light illuminance varies from 400 (sunrise/sunset) to 10,000 (midday).
+  // for typical values, see https://en.wikipedia.org/wiki/Lux#Illuminance
+  //
+  // for point and spot lights, this is the lumens/m^2 at 1m distance from the light. to transform from raw lumens, 
+  // divide lumens by ~12 (4*pi).
+  // e.g. a 100w household bulb with 1200 lumens would have an illuminance of ~100.
+  // a lighthouse bulb with 200,000 lumens would have an illuminance of ~15,000 (ignoring beam reflections)
+  // 
+  // default 
+  // for point/spotlights: 10,000
+  // for global directional light: depends on explorer implementation. may vary on light direction, time of day, etc
+  optional float illuminance = 2;
+  // whether the light should cast shadows.
+  // note: even when set to true the engine may not display shadows, or may only show shadows for a limited number 
+  // of lights depending on the implementation, platform, and user settings.
+  // default
+  // for point/spotlights: false / off
+  // for global directional light: true / on
+  optional bool shadows = 3;
+  // light color
+  // default White
+  optional decentraland.common.Color3 color = 4;
+}

proto/decentraland/sdk/components/main_camera.proto

@@ -0,0 +1,11 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1075;
+
+// PBMainCamera.virtualCameraEntity defines which VirtualCamera entity is active at the moment.
+// This component may hold 'repeated common.CameraTransition' transitionOverrides in the future
+message PBMainCamera {
+  optional uint32 virtual_camera_entity = 1; // current active virtual camera
+}

proto/decentraland/sdk/components/material.proto

@@ -22,6 +22,7 @@ message PBMaterial {
     optional float alpha_test = 2; // default = 0.5. range value: from 0 to 1
     optional bool cast_shadows = 3; // default =  true
     optional decentraland.common.Color4 diffuse_color = 4; // default = white;
+    optional decentraland.common.TextureUnion alpha_texture = 5; // default = null. Note that tilling and offset properties are ignored for this texture.
   }
 
   message PbrMaterial {
@@ -30,9 +31,9 @@ message PBMaterial {
     optional float alpha_test = 2; // default = 0.5. range value: from 0 to 1
     optional bool cast_shadows = 3; // default =  true
 
-    optional decentraland.common.TextureUnion alpha_texture = 4; // default = null
-    optional decentraland.common.TextureUnion emissive_texture = 5; // default = null
-    optional decentraland.common.TextureUnion bump_texture = 6; // default = null
+    optional decentraland.common.TextureUnion alpha_texture = 4; // @deprecated Alpha textures are no longer supported on PBRMaterial and UnlitMaterial.alphaTexture should be used instead.
+    optional decentraland.common.TextureUnion emissive_texture = 5; // default = null. Note that tilling and offset properties are ignored for this texture.
+    optional decentraland.common.TextureUnion bump_texture = 6; // default = null. Note that tilling and offset properties are ignored for this texture.
 
     optional decentraland.common.Color4 albedo_color = 7; // default = white;
     optional decentraland.common.Color3 emissive_color = 8; // default = black;

proto/decentraland/sdk/components/pointer_events.proto

@@ -25,7 +25,8 @@ message PBPointerEvents {
     optional common.InputAction button = 1; // key/button in use (default IA_ANY)
     optional string hover_text = 2;         // feedback on hover (default 'Interact')
     optional float max_distance = 3;        // range of interaction (default 10)
-    optional bool show_feedback = 4;        // enable or disable hover text (default true)
+    optional bool show_feedback = 4;        // enable or disable hover text and highlight (default true)
+    optional bool show_highlight = 5;       // enable or disable hover highlight (default true)
   }
 
   message Entry {

proto/decentraland/sdk/components/realm_info.proto

@@ -11,4 +11,5 @@ message PBRealmInfo {
   string comms_adapter = 4;
   bool is_preview = 5;
   optional string room = 6;
+  optional bool is_connected_scene_room = 7;
 }

proto/decentraland/sdk/components/spotlight.proto

@@ -0,0 +1,21 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1205;
+
+// defines a spotlight.
+// spotlights are point lights that emit light only in a cone around the transform's forward direction.
+// add this component together with the PBLight component to transform a point light into a spotlight.
+// note that spotlights do not model any internal reflections / focus, they only restrict the area of effect.
+// so for e.g. a torch beam, the bulb illuminance should be multiplied by the solid angle. 
+// a typical torch with a beam width of 15 degrees would use outer angle of 0.15 (7.5 degrees in radians),
+// and an illuminance approximately equal to the bulb's lumens, e.g. 1200.
+message PBSpotlight {
+  // the cone radius in radians. distance away from forward in which the light is visible. 
+  // for a torch a value around 0.15 is appropriate.    
+  float angle = 1;
+  // optional angle at which the light is brightest. should be <= outer angle. 
+  // if specified, the light will fall off smoothly between `inner_angle` and `angle`.
+  optional float inner_angle = 2;
+}

proto/decentraland/sdk/components/tween.proto

@@ -15,6 +15,7 @@ message PBTween {
     Move move = 3;
     Rotate rotate = 4;
     Scale scale = 5;
+    TextureMove texture_move = 8;
   }
 
   optional bool playing = 6; // default true (pause or running)
@@ -37,6 +38,19 @@ message Scale {
   decentraland.common.Vector3 end = 2;
 }
 
+// This tween mode allows to move the texture of a PbrMaterial or UnlitMaterial.
+// You can also specify the movement type (offset or tiling)
+message TextureMove {
+  decentraland.common.Vector2 start = 1;
+  decentraland.common.Vector2 end = 2;
+  optional TextureMovementType movement_type = 3; // default = TextureMovementType.TMT_OFFSET
+}
+
+enum TextureMovementType {
+  TMT_OFFSET = 0; // default = TextureMovementType.TMT_OFFSET
+  TMT_TILING = 1;
+}
+
 // Implementation guidelines for these easing functions can be found
 // at https://github.com/ai/easings.net/blob/6fcd5f852a470bf1a7890e8178afa0f471d5f2ec/src/easings/easingsFunctions.ts
 enum EasingFunction {

proto/decentraland/sdk/components/ui_canvas.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+
+import "decentraland/sdk/components/common/id.proto";
+package decentraland.sdk.components;
+
+option (common.ecs_component_id) = 1203;
+
+import "decentraland/common/colors.proto";
+
+// The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture.
+message PBUiCanvas {
+  uint32 width = 1;
+  uint32 height = 2;
+
+  optional decentraland.common.Color4 color = 3; // default = (0.0, 0.0, 0.0, 0.0) / transparent
+}

proto/decentraland/sdk/components/ui_transform.proto

@@ -166,4 +166,6 @@ message PBUiTransform {
 
   optional ScrollPositionValue scroll_position = 55; // default position=(0,0)
   optional ShowScrollBar scroll_visible = 56; // default ShowScrollBar.SSB_BOTH
+
+  optional int32 z_index = 57; // default 0
 }

proto/decentraland/sdk/components/virtual_camera.proto

@@ -0,0 +1,16 @@
+syntax = "proto3";
+package decentraland.sdk.components;
+
+import "decentraland/sdk/components/common/camera_transition.proto";
+import "decentraland/sdk/components/common/id.proto";
+option (common.ecs_component_id) = 1076;
+
+// PBVirtualCamera represents a camera to be used at some point in time during the scene execution
+// * The defaultTransition represents the transition TOWARDS this camera. If there is none, it's treated as
+// an 'instant' transition (like using speed/time = 0)
+// * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from 
+// the holding entity transform).
+message PBVirtualCamera {
+  optional common.CameraTransition default_transition = 1;
+  optional uint32 look_at_entity = 2;
+}

scripts/check-component-id.sh

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+if [ -z "$1" ]; then
+  echo "Usage: make check-component-id ID=<id>"
+  exit 1
+fi
+
+id=$1
+
+matches=$(find . -name "*.proto" -exec grep -l "option (common\.ecs_component_id) = $id;" {} +)
+
+if [ -z "$matches" ]; then
+  echo "id $id is free"
+else
+  echo "id $id is taken"
+fi

scripts/list-components-ids.sh

@@ -0,0 +1,14 @@
+#!/bin/bash
+
+ids=$(find . -name "*.proto" -exec grep -ho 'option (common\.ecs_component_id) = [0-9]\+;' {} + | sed -E 's/.*= ([0-9]+);/\1/' | sort -n)
+
+count=$(echo "$ids" | wc -l | xargs)
+
+echo "List of ids ($count total):"
+
+i=1
+echo "$ids" | while read id; do
+    echo "$i. $id"
+    ((i++))
+done
+