Add a map renderer (#3613)

Co-authored-by: github-actions <[email protected]>

Content.MapRenderer/Content.MapRenderer.csproj

@@ -0,0 +1,20 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net6.0</TargetFramework>
+        <OutputPath>..\bin\Content.MapRenderer\</OutputPath>
+        <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>
+
+    <ItemGroup>
+      <ProjectReference Include="..\Content.IntegrationTests\Content.IntegrationTests.csproj" />
+      <ProjectReference Include="..\RobustToolbox\Robust.UnitTesting\Robust.UnitTesting.csproj" />
+    </ItemGroup>
+
+    <ItemGroup>
+      <PackageReference Include="SixLabors.ImageSharp" Version="1.0.4" />
+    </ItemGroup>
+
+</Project>

Content.MapRenderer/Extensions/DirectoryExtensions.cs

@@ -0,0 +1,32 @@
+using System.IO;
+using System.Reflection;
+
+namespace Content.MapRenderer.Extensions
+{
+    public static class DirectoryExtensions
+    {
+        public static DirectoryInfo RepositoryRoot()
+        {
+            // space-station-14/bin/Content.MapRenderer/Content.MapRenderer.dll
+            var currentLocation = Assembly.GetExecutingAssembly().Location;
+
+            // space-station-14
+            return Directory.GetParent(currentLocation)!.Parent!.Parent!;
+        }
+
+        public static DirectoryInfo Resources()
+        {
+            return new DirectoryInfo($"{RepositoryRoot()}{Path.DirectorySeparatorChar}Resources");
+        }
+
+        public static DirectoryInfo Maps()
+        {
+            return new DirectoryInfo($"{Resources()}{Path.DirectorySeparatorChar}Maps");
+        }
+
+        public static DirectoryInfo MapImages()
+        {
+            return new DirectoryInfo($"{Resources()}{Path.DirectorySeparatorChar}MapImages");
+        }
+    }
+}

Content.MapRenderer/Extensions/EnvironmentExtensions.cs

@@ -0,0 +1,20 @@
+#nullable enable
+using System;
+using System.Diagnostics.CodeAnalysis;
+
+namespace Content.MapRenderer.Extensions
+{
+    public static class EnvironmentExtensions
+    {
+        public static bool TryGetVariable(string key, [NotNullWhen(true)] out string? value)
+        {
+            return (value = Environment.GetEnvironmentVariable(key)) != null;
+        }
+
+        public static string GetVariableOrThrow(string key)
+        {
+            return Environment.GetEnvironmentVariable(key) ??
+                   throw new ArgumentException($"No environment variable found with key {key}");
+        }
+    }
+}

Content.MapRenderer/Painters/EntityData.cs

@@ -0,0 +1,20 @@
+using Robust.Client.GameObjects;
+
+namespace Content.MapRenderer.Painters
+{
+    public class EntityData
+    {
+        public EntityData(SpriteComponent sprite, float x, float y)
+        {
+            Sprite = sprite;
+            X = x;
+            Y = y;
+        }
+
+        public SpriteComponent Sprite { get; }
+
+        public float X { get; }
+
+        public float Y { get; }
+    }
+}

Content.MapRenderer/Painters/EntityPainter.cs

@@ -0,0 +1,149 @@
+using System;
+using System.Collections.Generic;
+using Content.Shared.SubFloor;
+using Robust.Client.ResourceManagement;
+using Robust.Shared.GameObjects;
+using Robust.Shared.Timing;
+using SixLabors.ImageSharp;
+using SixLabors.ImageSharp.PixelFormats;
+using SixLabors.ImageSharp.Processing;
+using static Robust.Client.Graphics.RSI.State;
+using static Robust.UnitTesting.RobustIntegrationTest;
+
+namespace Content.MapRenderer.Painters;
+
+public class EntityPainter
+{
+    private readonly IResourceCache _cResourceCache;
+
+    private readonly Dictionary<(string path, string state), Image> _images;
+    private readonly Image _errorImage;
+
+    private readonly IEntityManager _sEntityManager;
+
+    public EntityPainter(ClientIntegrationInstance client, ServerIntegrationInstance server)
+    {
+        _cResourceCache = client.ResolveDependency<IResourceCache>();
+
+        _sEntityManager = server.ResolveDependency<IEntityManager>();
+
+        _images = new Dictionary<(string path, string state), Image>();
+        _errorImage = Image.Load<Rgba32>(_cResourceCache.ContentFileRead("/Textures/error.rsi/error.png"));
+    }
+
+    public void Run(Image canvas, List<EntityData> entities)
+    {
+        var stopwatch = new Stopwatch();
+        stopwatch.Start();
+
+        // TODO cache this shit what are we insane
+        entities.Sort(Comparer<EntityData>.Create((x, y) => x.Sprite.DrawDepth.CompareTo(y.Sprite.DrawDepth)));
+
+        foreach (var entity in entities)
+        {
+            Run(canvas, entity);
+        }
+
+        Console.WriteLine($"{nameof(GridPainter)} painted {entities.Count} entities in {(int) stopwatch.Elapsed.TotalMilliseconds} ms");
+    }
+
+    public void Run(Image canvas, EntityData entity)
+    {
+        if (_sEntityManager.HasComponent<SubFloorHideComponent>(entity.Sprite.Owner))
+        {
+            return;
+        }
+
+        if (!entity.Sprite.Visible || entity.Sprite.ContainerOccluded)
+        {
+            return;
+        }
+
+        var worldRotation = _sEntityManager.GetComponent<TransformComponent>(entity.Sprite.Owner).WorldRotation;
+        foreach (var layer in entity.Sprite.AllLayers)
+        {
+            if (!layer.Visible)
+            {
+                continue;
+            }
+
+            if (!layer.RsiState.IsValid)
+            {
+                continue;
+            }
+
+            var rsi = layer.ActualRsi;
+            Image image;
+
+            if (rsi == null || rsi.Path == null || !rsi.TryGetState(layer.RsiState, out var state))
+            {
+                image = _errorImage;
+            }
+            else
+            {
+                var key = (rsi.Path!.ToString(), state.StateId.Name!);
+
+                if (!_images.TryGetValue(key, out image!))
+                {
+                    var stream = _cResourceCache.ContentFileRead($"{rsi.Path}/{state.StateId}.png");
+                    image = Image.Load<Rgba32>(stream);
+
+                    _images[key] = image;
+                }
+            }
+
+            image = image.CloneAs<Rgba32>();
+
+            var directions = entity.Sprite.GetLayerDirectionCount(layer);
+
+            // TODO add support for 8 directions and animations (delays)
+            if (directions != 1 && directions != 8)
+            {
+                double xStart, xEnd, yStart, yEnd;
+
+                switch (directions)
+                {
+                    case 4:
+                    {
+                        var dir = layer.EffectiveDirection(worldRotation);
+
+                        (xStart, xEnd, yStart, yEnd) = dir switch
+                        {
+                            // Only need the first tuple as doubles for the compiler to recognize it
+                            Direction.South => (0d, 0.5d, 0d, 0.5d),
+                            Direction.East => (0, 0.5, 0.5, 1),
+                            Direction.North => (0.5, 1, 0, 0.5),
+                            Direction.West => (0.5, 1, 0.5, 1),
+                            _ => throw new ArgumentOutOfRangeException(nameof(dir))
+                        };
+                        break;
+                    }
+                    default:
+                        throw new ArgumentOutOfRangeException();
+                }
+
+                var x = (int) (image.Width * xStart);
+                var width = (int) (image.Width * xEnd) - x;
+
+                var y = (int) (image.Height * yStart);
+                var height = (int) (image.Height * yEnd) - y;
+
+                image.Mutate(o => o.Crop(new Rectangle(x, y, width, height)));
+            }
+
+            var colorMix = entity.Sprite.Color * layer.Color;
+            var imageColor = Color.FromRgba(colorMix.RByte, colorMix.GByte, colorMix.BByte, colorMix.AByte);
+            var coloredImage = new Image<Rgba32>(image.Width, image.Height);
+            coloredImage.Mutate(o => o.BackgroundColor(imageColor));
+
+            image.Mutate(o => o
+                .DrawImage(coloredImage, PixelColorBlendingMode.Multiply, PixelAlphaCompositionMode.SrcAtop, 1)
+                .Resize(32, 32)
+                .Flip(FlipMode.Vertical));
+
+            var pointX = (int) entity.X;
+            var pointY = (int) entity.Y;
+            canvas.Mutate(o => o.DrawImage(image, new Point(pointX, pointY), 1));
+        }
+    }
+}

Content.MapRenderer/Painters/GridPainter.cs

@@ -0,0 +1,103 @@
+using System;
+using System.Collections.Concurrent;
+using System.Collections.Generic;
+using System.Linq;
+using Robust.Client.GameObjects;
+using Robust.Shared.GameObjects;
+using Robust.Shared.Map;
+using Robust.Shared.Timing;
+using SixLabors.ImageSharp;
+using static Robust.UnitTesting.RobustIntegrationTest;
+
+namespace Content.MapRenderer.Painters
+{
+    public class GridPainter
+    {
+        private readonly EntityPainter _entityPainter;
+
+        private readonly IEntityManager _cEntityManager;
+        private readonly IMapManager _cMapManager;
+
+        private readonly IEntityManager _sEntityManager;
+
+        private readonly ConcurrentDictionary<GridId, List<EntityData>> _entities;
+
+        public GridPainter(ClientIntegrationInstance client, ServerIntegrationInstance server)
+        {
+            _entityPainter = new EntityPainter(client, server);
+
+            _cEntityManager = client.ResolveDependency<IEntityManager>();
+            _cMapManager = client.ResolveDependency<IMapManager>();
+
+            _sEntityManager = server.ResolveDependency<IEntityManager>();
+
+            _entities = GetEntities();
+        }
+
+        public void Run(Image gridCanvas, IMapGrid grid)
+        {
+            var stopwatch = new Stopwatch();
+            stopwatch.Start();
+
+            if (!_entities.TryGetValue(grid.Index, out var entities))
+            {
+                Console.WriteLine($"No entities found on grid {grid.Index}");
+                return;
+            }
+
+            _entityPainter.Run(gridCanvas, entities);
+            Console.WriteLine($"{nameof(GridPainter)} painted grid {grid.Index} in {(int) stopwatch.Elapsed.TotalMilliseconds} ms");
+        }
+
+        private ConcurrentDictionary<GridId, List<EntityData>> GetEntities()
+        {
+            var stopwatch = new Stopwatch();
+            stopwatch.Start();
+
+            var components = new ConcurrentDictionary<GridId, List<EntityData>>();
+
+            foreach (var entity in _sEntityManager.GetEntities())
+            {
+                if (!_sEntityManager.HasComponent<ISpriteComponent>(entity))
+                {
+                    continue;
+                }
+
+                var prototype = _sEntityManager.GetComponent<MetaDataComponent>(entity).EntityPrototype;
+                if (prototype == null)
+                {
+                    continue;
+                }
+
+                if (!_cEntityManager.TryGetComponent(entity, out SpriteComponent sprite))
+                {
+                    throw new InvalidOperationException(
+                        $"No sprite component found on an entity for which a server sprite component exists. Prototype id: {prototype.ID}");
+                }
+
+                var xOffset = 0;
+                var yOffset = 0;
+                var tileSize = 1;
+
+                var transform = _sEntityManager.GetComponent<TransformComponent>(entity);
+                if (_cMapManager.TryGetGrid(transform.GridID, out var grid))
+                {
+                    xOffset = (int) Math.Abs(grid.LocalBounds.Left);
+                    yOffset = (int) Math.Abs(grid.LocalBounds.Bottom);
+                    tileSize = grid.TileSize;
+                }
+
+                var position = transform.LocalPosition;
+                var x = ((float) Math.Floor(position.X) + xOffset) * tileSize * TilePainter.TileImageSize;
+                var y = ((float) Math.Floor(position.Y) + yOffset) * tileSize * TilePainter.TileImageSize;
+                var data = new EntityData(sprite, x, y);
+
+                components.GetOrAdd(transform.GridID, _ => new List<EntityData>()).Add(data);
+            }
+
+            Console.WriteLine($"Found {components.Values.Sum(l => l.Count)} entities on {components.Count} grids in {(int) stopwatch.Elapsed.TotalMilliseconds} ms");
+
+            return components;
+        }
+    }
+}