2 using System.Collections.Concurrent;
3 using System.Collections.Generic;
6 using System.Reflection;
8 using System.Text.RegularExpressions;
9 using System.Threading;
12 using Hjg.Pngcs.Chunks;
14 using Newtonsoft.Json;
18 using Vintagestory.API.Client;
19 using Vintagestory.API.Common;
20 using Vintagestory.API.Config;
21 using Vintagestory.API.Datastructures;
22 using Vintagestory.API.MathTools;
23 using Vintagestory.Common;
27 public class AutomapSystem
29 private Thread cartographer_thread;
30 private ICoreClientAPI ClientAPI { get; set; }
31 private ILogger Logger { get; set; }
32 private IChunkRenderer ChunkRenderer { get; set; }
33 private JsonGenerator JsonGenerator { get; set; }
35 private const string _mapPath = @"Maps";
36 private const string _chunkPath = @"Chunks";
37 private const string _domain = @"automap";
38 private const string chunkFile_filter = @"*_*.png";
39 private const string poiFileName = @"poi_binary";
40 private const string eoiFileName = @"eoi_binary";
41 private const string pointsTsvFileName = @"points_of_interest.tsv";
42 private static Regex chunkShardRegex = new Regex(@"(?<X>[\d]+)_(?<Z>[\d]+).png", RegexOptions.Singleline);
44 private ConcurrentDictionary<Vec2i, uint> columnCounter = new ConcurrentDictionary<Vec2i, uint>(3, 150);
45 private ColumnsMetadata chunkTopMetadata;
46 private PointsOfInterest POIs = new PointsOfInterest();
47 private EntitiesOfInterest EOIs = new EntitiesOfInterest();
48 private string jsonPreBuilt;
50 internal Dictionary<int, BlockDesignator> BlockID_Designators { get; private set; }
51 internal Dictionary<AssetLocation, EntityDesignator> Entity_Designators { get; private set; }
52 internal Dictionary<int, string> RockIdCodes { get; private set; }
54 internal CommandType CurrentState { get; set; }
55 //Run status, Chunks processed, stats, center of map....
56 private uint nullChunkCount, updatedChunksTotal;
57 private Vec2i startChunkColumn;
59 private readonly int chunkSize;
61 private IAsset staticMap;
62 private PersistedConfiguration configuration;
65 public static string AutomapStatusEventKey = @"AutomapStatus";
66 public static string AutomapCommandEventKey = @"AutomapCommand";
67 PersistedConfiguration cachedConfiguration;
69 public AutomapSystem(ICoreClientAPI clientAPI, ILogger logger, PersistedConfiguration config)
71 this.ClientAPI = clientAPI;
73 chunkSize = ClientAPI.World.BlockAccessor.ChunkSize;
74 ClientAPI.Event.LevelFinalize += EngageAutomap;
75 configuration = config;
78 //TODO:Choose which one from GUI
79 this.ChunkRenderer = new StandardRenderer(clientAPI, logger);
81 //Listen on bus for commands
82 ClientAPI.Event.RegisterEventBusListener(CommandListener, 1.0, AutomapSystem.AutomapCommandEventKey);
84 if (configuration.Autostart)
86 CurrentState = CommandType.Run;
87 Logger.Debug("Autostart is Enabled.");
94 private void EngageAutomap()
96 path = ClientAPI.GetOrCreateDataPath(_mapPath);
97 path = ClientAPI.GetOrCreateDataPath(Path.Combine(path, "World_" + ClientAPI.World.Seed));//Add name of World too...'ServerApi.WorldManager.CurrentWorldName'
98 JsonGenerator = new JsonGenerator(ClientAPI, Logger, path);
100 string mapFilename = Path.Combine(path, "automap.html");
101 StreamWriter outputText = new StreamWriter(File.Open(mapFilename, FileMode.Create, FileAccess.Write, FileShare.ReadWrite));
103 staticMap = ClientAPI.World.AssetManager.Get(new AssetLocation(_domain, "config/automap.html"));
104 outputText.Write(staticMap.ToText());
107 jsonPreBuilt = JsonGenerator.MakePreBuiltJSON();
109 Prefill_POI_Designators();
110 startChunkColumn = new Vec2i((ClientAPI.World.Player.Entity.LocalPos.AsBlockPos.X / chunkSize), (ClientAPI.World.Player.Entity.LocalPos.AsBlockPos.Z / chunkSize));
111 chunkTopMetadata = new ColumnsMetadata(startChunkColumn);
113 Logger.Notification("AUTOMAP Start {0}", startChunkColumn);
116 ClientAPI.Event.ChunkDirty += ChunkAChanging;
118 cartographer_thread = new Thread(Cartographer)
120 Name = "Cartographer",
121 Priority = ThreadPriority.Lowest,
125 ClientAPI.Event.RegisterGameTickListener(AwakenCartographer, 6000);
128 private void ChunkAChanging(Vec3i chunkCoord, IWorldChunk chunk, EnumChunkDirtyReason reason)
130 Vec2i topPosition = new Vec2i(chunkCoord.X, chunkCoord.Z);
132 columnCounter.AddOrUpdate(topPosition, 1, (key, colAct) => colAct + 1);
135 private void AwakenCartographer(float delayed)
138 if (CurrentState == CommandType.Run && (ClientAPI.IsGamePaused != false || ClientAPI.IsShuttingDown != true))
141 Logger.VerboseDebug("Cartographer re-trigger from [{0}]", cartographer_thread.ThreadState);
144 if (cartographer_thread.ThreadState.HasFlag(ThreadState.Unstarted))
146 cartographer_thread.Start();
148 else if (cartographer_thread.ThreadState.HasFlag(ThreadState.WaitSleepJoin))
150 //Time to (re)write chunk shards
151 cartographer_thread.Interrupt();
154 //ClientAPI.TriggerChatMessage($"Automap {updatedChunksTotal} Updates - MAX (N:{chunkTopMetadata.North_mostChunk},S:{chunkTopMetadata.South_mostChunk},E:{chunkTopMetadata.East_mostChunk}, W:{chunkTopMetadata.West_mostChunk} - TOTAL: {chunkTopMetadata.Count})");
157 else if (CurrentState == CommandType.Snapshot)
159 //TODO: Snapshot generator second thread...
165 private void Cartographer()
168 Logger.VerboseDebug("Cartographer thread awoken");
172 uint ejectedItem = 0;
173 uint updatedChunks = 0;
174 uint updatedPixels = 0;
176 //-- Should dodge enumerator changing underfoot....at a cost.
177 if (!columnCounter.IsEmpty)
179 var tempSet = columnCounter.ToArray().OrderByDescending(kvp => kvp.Value);
180 UpdateEntityMetadata();
182 foreach (var mostActiveCol in tempSet)
184 var mapChunk = ClientAPI.World.BlockAccessor.GetMapChunk(mostActiveCol.Key);
186 if (mapChunk == null)
188 Logger.Warning("SKIP CHUNK: ({0}) - Map Chunk NULL!", mostActiveCol.Key);
190 columnCounter.TryRemove(mostActiveCol.Key, out ejectedItem);
194 ColumnMeta chunkMeta;
195 if (chunkTopMetadata.Contains(mostActiveCol.Key))
197 chunkMeta = chunkTopMetadata[mostActiveCol.Key];
201 chunkMeta = CreateColumnMetadata(mostActiveCol, mapChunk);
204 ProcessChunkBlocks(mostActiveCol.Key, mapChunk, ref chunkMeta);
206 PngWriter pngWriter = SetupPngImage(mostActiveCol.Key, chunkMeta);
207 ChunkRenderer.GenerateChunkPngShard(mostActiveCol.Key, mapChunk, chunkMeta, pngWriter, out updatedPixels);
209 if (updatedPixels > 0)
213 Logger.VerboseDebug("Wrote chunk shard: ({0}) - Edits#:{1}, Pixels#:{2}", mostActiveCol.Key, mostActiveCol.Value, updatedPixels);
216 chunkTopMetadata.Update(chunkMeta);
217 columnCounter.TryRemove(mostActiveCol.Key, out ejectedItem);
221 columnCounter.TryRemove(mostActiveCol.Key, out ejectedItem);
222 Logger.VerboseDebug("Un-painted chunk: ({0}) ", mostActiveCol.Key);
228 UpdateStatus(this.updatedChunksTotal, this.nullChunkCount, updatedChunks);
230 if (updatedChunks > 0)
232 //What about chunk updates themselves; a update bitmap isn't kept...
233 updatedChunksTotal += updatedChunks;
234 JsonGenerator.GenerateJSONMetadata(chunkTopMetadata, startChunkColumn, POIs, EOIs, RockIdCodes);
238 //Then sleep until interupted again, and repeat
240 Logger.VerboseDebug("Thread '{0}' about to sleep indefinitely.", Thread.CurrentThread.Name);
242 Thread.Sleep(Timeout.Infinite);
245 catch (ThreadInterruptedException)
248 Logger.VerboseDebug("Thread '{0}' interupted [awoken]", Thread.CurrentThread.Name);
252 catch (ThreadAbortException)
254 Logger.VerboseDebug("Thread '{0}' aborted.", Thread.CurrentThread.Name);
259 Logger.VerboseDebug("Thread '{0}' executing finally block.", Thread.CurrentThread.Name);
260 PersistPointsData( );
264 private void UpdateStatus(uint totalUpdates, uint voidChunks, uint delta)
266 StatusData updateData = new StatusData(totalUpdates, voidChunks, delta, CommandType.Run);
268 this.ClientAPI.Event.PushEvent(AutomapStatusEventKey, updateData);
271 private void Prefill_POI_Designators()
274 this.BlockID_Designators = new Dictionary<int, BlockDesignator>();
275 this.Entity_Designators = new Dictionary<AssetLocation, EntityDesignator>();
276 this.RockIdCodes = Helpers.ArbitrarytBlockIdHunter(ClientAPI, new AssetLocation(GlobalConstants.DefaultDomain, "rock-"), EnumBlockMaterial.Stone);
278 //Add special marker types for BlockID's of "Interest", overwrite colour, and method
280 Reload_POI_Designators();
283 private void Reload_POI_Designators()
285 Logger.VerboseDebug("Connecting {0} Configured Block-Designators", configuration.BlockDesignators.Count);
286 foreach (var designator in configuration.BlockDesignators)
288 var blockIDs = Helpers.ArbitrarytBlockIdHunter(ClientAPI, designator.Pattern, designator.Material);
289 if (blockIDs.Count > 0) { Logger.VerboseDebug("Designator {0} has {1} associated blockIDs", designator.ToString(), blockIDs.Count); }
290 foreach (var entry in blockIDs)
292 BlockID_Designators.Add(entry.Key, designator);
295 this.ChunkRenderer.BlockID_Designators = BlockID_Designators;
298 Logger.VerboseDebug("Connecting {0} Configured Entity-Designators", configuration.EntityDesignators.Count);
299 foreach (var designator in configuration.EntityDesignators)
301 //Get Variants first, from EntityTypes...better be populated!
302 var matched = ClientAPI.World.EntityTypes.FindAll(entp => entp.Code.BeginsWith(designator.Pattern.Domain, designator.Pattern.Path));
304 foreach (var match in matched)
306 Logger.VerboseDebug("Linked Entity: {0} Designator: {1}", match.Code, designator);
307 this.Entity_Designators.Add(match.Code, designator);
312 //EntityProperties props = ClientAPI.World.GetEntityType(designator.Pattern);
321 /// Store Points/Entity of Interest
323 private void PersistPointsData( )
325 //POI and EOI raw dump files ~ WRITE em!
326 //var poiRawFile = File.
327 string poiPath = Path.Combine(path, poiFileName);
328 string eoiPath = Path.Combine(path, eoiFileName);
330 if (this.POIs.Count > 0) {
331 using (var poiFile = File.OpenWrite(poiPath)) {
332 Serializer.Serialize<PointsOfInterest>(poiFile, this.POIs);
336 if (this.EOIs.Count > 0) {
337 using (var eoiFile = File.OpenWrite(eoiPath)) {
338 Serializer.Serialize<EntitiesOfInterest>(eoiFile, this.EOIs);
342 //Create Easy to Parse TSV file for tool/human use....
343 string pointsTsvPath = Path.Combine(path, pointsTsvFileName);
345 using (var tsvWriter = new StreamWriter(pointsTsvPath, false, Encoding.UTF8))
347 tsvWriter.WriteLine("Name\tDescription\tLocation\tTime\t");
348 foreach (var point in this.POIs) {
349 tsvWriter.Write(point.Name + "\t");
350 tsvWriter.Write(point.Notes + "\t");
351 tsvWriter.Write(point.Location.PrettyCoords(ClientAPI) + "\t");
352 tsvWriter.Write(point.Timestamp.ToString("u")+"\t");
353 tsvWriter.WriteLine();
355 foreach (var entity in this.EOIs) {
356 tsvWriter.Write(entity.Name + "\t");
357 tsvWriter.Write(entity.Notes + "\t");
358 tsvWriter.Write(entity.Location.PrettyCoords(ClientAPI) + "\t");
359 tsvWriter.Write(entity.Timestamp.ToString("u") + "\t");
360 tsvWriter.WriteLine( );
362 tsvWriter.WriteLine();
368 private ColumnMeta CreateColumnMetadata(KeyValuePair<Vec2i, uint> mostActiveCol, IMapChunk mapChunk)
370 ColumnMeta data = new ColumnMeta(mostActiveCol.Key.Copy(), (byte) chunkSize);
371 BlockPos equivBP = new BlockPos(mostActiveCol.Key.X * chunkSize,
373 mostActiveCol.Key.Y * chunkSize);
375 var climate = ClientAPI.World.BlockAccessor.GetClimateAt(equivBP);
376 data.UpdateFieldsFrom(climate, mapChunk, TimeSpan.FromHours(ClientAPI.World.Calendar.TotalHours));
382 /// Reload chunk bounds from chunk shards
384 /// <returns>The metadata.</returns>
385 private void Reload_Metadata()
387 var worldmapDir = new DirectoryInfo(path);
389 if (worldmapDir.Exists)
392 var shardFiles = worldmapDir.GetFiles(chunkFile_filter);
394 if (shardFiles.Length > 0)
397 Logger.VerboseDebug("Metadata reloading from {0} shards", shardFiles.Length);
400 foreach (var shardFile in shardFiles) {
402 if (shardFile.Length < 1024) continue;
403 var result = chunkShardRegex.Match(shardFile.Name);
404 if (result.Success) {
405 int X_chunk_pos = int.Parse(result.Groups["X"].Value);
406 int Z_chunk_pos = int.Parse(result.Groups["Z"].Value);
410 using (var fileStream = shardFile.OpenRead( )) {
412 PngReader pngRead = new PngReader(fileStream);
413 pngRead.ReadSkippingAllRows( );
415 //Parse PNG chunks for METADATA in shard
416 PngMetadataChunk metadataFromPng = pngRead.GetChunksList( ).GetById1(PngMetadataChunk.ID) as PngMetadataChunk;
418 chunkTopMetadata.Add(metadataFromPng.ChunkMetadata);
422 catch (PngjException someEx)
424 Logger.Error("PNG Corruption file '{0}' - Reason: {1}", shardFile.Name, someEx);
432 //POI and EOI raw dump files ~ reload em!
433 //var poiRawFile = File.
434 string poiPath = Path.Combine(path, poiFileName);
435 string eoiPath = Path.Combine(path, eoiFileName);
437 if (File.Exists(poiPath)) {
438 using (var poiFile = File.OpenRead(poiPath)) {
439 this.POIs = Serializer.Deserialize<PointsOfInterest>(poiFile);
440 Logger.VerboseDebug("Reloaded {0} POIs from file.", this.POIs.Count);
444 if (File.Exists(eoiPath)) {
445 using (var eoiFile = File.OpenRead(eoiPath)) {
446 this.EOIs = Serializer.Deserialize<EntitiesOfInterest>(eoiFile);
447 Logger.VerboseDebug("Reloaded {0} EOIs from file.", this.EOIs.Count);
455 Logger.VerboseDebug("Could not open world map directory");
463 private PngWriter SetupPngImage(Vec2i coord, ColumnMeta metadata)
465 ImageInfo imageInf = new ImageInfo(chunkSize, chunkSize, 8, false);
467 string filename = $"{coord.X}_{coord.Y}.png";
468 filename = Path.Combine(path, filename);
470 PngWriter pngWriter = FileHelper.CreatePngWriter(filename, imageInf, true);
471 PngMetadata meta = pngWriter.GetMetadata();
473 meta.SetText("Chunk_X", coord.X.ToString("D"));
474 meta.SetText("Chunk_Y", coord.Y.ToString("D"));
475 //Setup specialized meta-data PNG chunks here...
476 PngMetadataChunk pngChunkMeta = new PngMetadataChunk(pngWriter.ImgInfo)
478 ChunkMetadata = metadata
480 pngWriter.GetChunksList().Queue(pngChunkMeta);
481 pngWriter.CompLevel = 9;// 9 is the maximum compression
482 pngWriter.CompressionStrategy = Hjg.Pngcs.Zlib.EDeflateCompressStrategy.Huffman;
488 /// Does the heavy lifting of Scanning columns of chunks - scans for BlockEntity, creates Heightmap and stats...
490 /// <param name="key">Chunk Coordinate</param>
491 /// <param name="mapChunk">Map chunk.</param>
492 /// <param name="chunkMeta">Chunk metadata</param>
493 private void ProcessChunkBlocks(Vec2i key, IMapChunk mapChunk, ref ColumnMeta chunkMeta)
496 int targetChunkY = mapChunk.YMax / chunkSize;//Surface ...
497 for (; targetChunkY > 0; targetChunkY--)
499 WorldChunk chunkData = ClientAPI.World.BlockAccessor.GetChunk(key.X, targetChunkY, key.Y) as WorldChunk;
501 if (chunkData == null || chunkData.BlockEntities == null) {
503 Logger.VerboseDebug("Chunk null or empty X{0} Y{1} Z{2}", key.X, targetChunkY, key.Y);
508 /*************** Chunk Entities Scanning *********************/
509 if (chunkData.BlockEntities != null && chunkData.BlockEntities.Length > 0)
512 Logger.VerboseDebug("Surface@ {0} = BlockEntities: {1}", key, chunkData.BlockEntities.Length);
515 foreach (var blockEnt in chunkData.BlockEntities)
518 if (blockEnt != null && blockEnt.Block != null && BlockID_Designators.ContainsKey(blockEnt.Block.BlockId))
520 var designator = BlockID_Designators[blockEnt.Block.BlockId];
521 designator.SpecialAction(ClientAPI, POIs, blockEnt.Pos.Copy(), blockEnt.Block);
526 /********************* Chunk/Column BLOCKs scanning ****************/
527 //Heightmap, Stats, block tally
530 int X_index, Y_index, Z_index;
531 X_index = Y_index = Z_index = 0;
539 /* Encode packed indicie
540 (y * chunksize + z) * chunksize + x
542 var indicie = Helpers.ChunkBlockIndicie16(X_index, Y_index, Z_index);
543 int aBlockId = chunkData.Blocks[indicie];
547 chunkMeta.AirBlocks++;
551 if (RockIdCodes.ContainsKey(aBlockId))
553 if (chunkMeta.RockRatio.ContainsKey(aBlockId)) { chunkMeta.RockRatio[aBlockId]++; } else { chunkMeta.RockRatio.Add(aBlockId, 1); }
556 chunkMeta.NonAirBlocks++;
559 if (chunkMeta.HeightMap[X_index, Z_index] == 0)
560 { chunkMeta.HeightMap[X_index, Z_index] = (ushort) (Y_index + (targetChunkY * chunkSize)); }
563 while (X_index++ < (chunkSize - 1));
566 while (Z_index++ < (chunkSize - 1));
569 while (Y_index++ < (chunkSize - 1));
574 private void UpdateEntityMetadata()
576 Logger.Debug("Presently {0} Entities", ClientAPI.World.LoadedEntities.Count);
577 //Mabey scan only for 'new' entities by tracking ID in set?
578 foreach (var loadedEntity in ClientAPI.World.LoadedEntities.ToArray())
582 //Logger.VerboseDebug($"ENTITY: ({loadedEntity.Value.Code}) = #{loadedEntity.Value.EntityId} {loadedEntity.Value.State} {loadedEntity.Value.LocalPos} <<<<<<<<<<<<");
585 var dMatch = Entity_Designators.SingleOrDefault(se => se.Key.Equals(loadedEntity.Value.Code));
586 if (dMatch.Value != null)
588 dMatch.Value.SpecialAction(ClientAPI, this.EOIs, loadedEntity.Value.LocalPos.AsBlockPos.Copy(), loadedEntity.Value);
596 private void AddNote(string notation)
598 var playerNodePoi = new PointOfInterest()
601 Location = ClientAPI.World.Player.Entity.LocalPos.AsBlockPos.Copy(),
603 Timestamp = DateTime.UtcNow,
606 this.POIs.AddReplace(playerNodePoi);
611 private void CommandListener(string eventName, ref EnumHandling handling, IAttribute data)
613 Logger.VerboseDebug("MsgBus RX: AutomapCommandMsg: {0}", data.ToJsonToken());
615 CommandData cmdData = data as CommandData;
618 if (CurrentState != CommandType.Snapshot)
620 switch (cmdData.State)
622 case CommandType.Run:
623 case CommandType.Stop:
624 if (CurrentState != cmdData.State) {
625 CurrentState = cmdData.State;
626 AwakenCartographer(0.0f);
630 case CommandType.Snapshot:
631 CurrentState = CommandType.Stop;
632 //Snapshot starts a second thread/process...
636 case CommandType.Notation:
637 //Add to POI list where player location
638 AddNote(cmdData.Notation);
646 ClientAPI.TriggerChatMessage($"Automap commanded to: {cmdData.State} ");