@dcl/protocol 1.0.0-10043247792.commit-428d1eb → 1.0.0-10047077926.commit-ea61304

package/proto/decentraland/realm/about.proto

@@ -1,6 +1,9 @@
 syntax = "proto3";
 package decentraland.realm;
 
+import "decentraland/common/border_rect.proto";
+import "decentraland/common/vectors.proto";
+
 message AboutResponse {
   bool healthy = 1;
   AboutConfiguration configurations = 2;
@@ -10,10 +13,65 @@ message AboutResponse {
   optional BffInfo bff = 6;
   bool accepting_users = 7;
 
+  // @deprecated This message was never used but it's still here for compatibility reasons
   message MinimapConfiguration {
-    bool enabled = 1;
-    optional string data_image = 2;
-    optional string estate_image = 3;
+    reserved 1;
+    reserved "enabled";
+    reserved 2;
+    reserved "data_image";
+    reserved 3;
+    reserved "estate_image";
+  }
+
+  message MapConfiguration {
+    // whether the minimap should be rendered
+    bool minimap_enabled = 1;
+  
+    // the union of all rects here represents the places where that MAY have scenes
+    //  - all the other parcels are considered as empty, up to the explorer to decide if they're walkable or not
+    //  - the contained square is determined by points: 
+    //    - top-left      with  minX, maxY 
+    //    - bottom-left   with  minX, minY
+    //    - top-right     with  maxX, maxY 
+    //    - bottom-right  with  maxX, maxY 
+    //  Note: the coordinate system used is the Cartesian coordinate system, where the y-axis increases upwards, 
+    //    not the screen coordinate system, where the origin is at the top-left corner and the y-axis increases downwards.
+    repeated decentraland.common.BorderRect sizes = 2; 
+  
+    // ImageViewWithZoomLevel uses a description to render the minimap
+    //  using different images with different zoom levels.
+    // When `version='v1'`:
+    // - The description allows the explorer to form the URL:
+    //  url(x,y,zoom_level) = `{base_url}/{zoom_level}/{x},{y}{suffix_url}`
+    // - The given URL is for an image where the pixel `0,0` for the image `0,0` always
+    //    points to the top-left contained square.
+    // - The `zoom_level=1` is to a ratio of 3.2 pixel per parcel, this means in a 32x32 pixel square
+    //    you get 10x10 parcels. 
+    // - Each increase of zoom level, double the ratio pixel per parcels. 
+    message ImageViewWithZoomLevel {
+      // options: ['v1']
+      string version = 1; 
+      optional string base_url = 2;
+      optional string suffix_url = 3;
+      optional decentraland.common.Vector2 top_left_offset = 4;
+    }
+  
+    // ParcelView uses a description to render the minimap
+    //  using a image where each pixel is a parcel and each pixel
+    //  has the metadata to make a representation (using a shader or image-generation client-side)
+    // When `version='v1'`:
+    //  - The pixel `0,0` is the top-left contained square
+    //  - The image has to be at least of contained square pixels size
+    //  - The metadata inside each pixel follows the generated with the atlas server https://github.com/decentraland/atlas-server/blob/af371f2a59745a1f50b0b0b2382984288c4ae891/src/adapters/mini-map-renderer.ts#L27
+    message ParcelView {
+      // options: `v1`
+      string version = 1; 
+      optional string image_url = 2;
+    }
+  
+    optional ImageViewWithZoomLevel satellite_view = 5;
+    optional ParcelView parcel_view = 6;
+    optional ImageViewWithZoomLevel thumbnail_view = 7;
   }
 
   message SkyboxConfiguration {
@@ -26,13 +84,15 @@ message AboutResponse {
     uint32 network_id = 2;
     repeated string global_scenes_urn = 3;
     repeated string scenes_urn = 4;
-    optional MinimapConfiguration minimap = 5;
+    reserved 5;
+    reserved "minimap";
     optional SkyboxConfiguration skybox = 6;
 
     // A content server to be used to load the parcels around the user. Uses the POST /entities/active endpoint
     // to continously fetch the parcels around the users. if null, then the default content server will be used
     // if == "" then the city_loader will be disabled and the scenes_urn will be used to load the world
     optional string city_loader_content_server = 7;
+    optional MapConfiguration map = 8;
   }
 
   message ContentInfo {