VS LiveMap Revival

<h1>VS LiveMap Revival</h1> <p><img src="https://raw.githubusercontent.com/mja00/VS-LiveMap-Revival/master/.github/images/og.webp" alt="Banner" /></p> <p><strong>VS LiveMap Revival</strong> is a continuation of the original <strong>VS LiveMap</strong> by BillyGalbreath.</p> <p>This project picks up where the original left off&mdash;forked from the old branch before the project was archived. At the time, the mod was in the middle of a refactor, and much of the original documentation and wikis were removed. This revival aims to bring the map back to life, fix bugs, and restore functionality for the Vintage Story community.</p> <blockquote> <p><strong>A Personal Note:</strong> I am picking this up as my first proper C# project. Development, bug fixes, and new features might come a bit slowly as I learn the ropes, but I am committed to getting this working smoothly!</p> </blockquote> <h2>Features</h2> <ul> <li><strong>Integrated Web Server</strong> <ul> <li>Works out-of-the-box with no external dependencies (Apache/Nginx not required).</li> <li>Host the map directly from your game server.</li> </ul> </li> <li><strong>Real-time Updates</strong> <ul> <li>The map updates automatically as players explore, build, and modify the world.</li> </ul> </li> <li><strong>Built-in Layers</strong> <ul> <li><strong>Players</strong>: See online players and their health in real-time.</li> <li><strong>Traders</strong>: Automatically marks discovered trader locations.</li> <li><strong>Translocators</strong>: Tracks discovered translocators to help with navigation.</li> <li><strong>Spawn</strong>: Highlights the world's default spawn point.</li> </ul> </li> <li><strong>Multiple Rendering Styles</strong> <ul> <li>Choose between styles like <strong>Basic</strong> and <strong>Sepia</strong> to fit your preference.</li> </ul> </li> <li><strong>High Performance</strong> <ul> <li>Uses asynchronous rendering and task management to minimize impact on server ticks.</li> </ul> </li> <li><strong>Extensive API</strong> <ul> <li>Developer-friendly API allows other mods to add custom layers and markers easily.</li> </ul> </li> <li><strong>Customizable UI</strong> <ul> <li>Configure the logo, title, and attribution to match your server's identity.</li> </ul> </li> <li><strong>Mod Integration</strong> <ul> <li>Display shared waypoints from <a href="https://mods.vintagestory.at/nbcartographer" target="_blank" rel="noopener">Cartographer</a></li> </ul> </li> </ul> <p>&nbsp;</p> <p>&nbsp;</p> <p><strong>Demo Server:</strong> <a href="https://vslivemap.mart.fyi/">https://vslivemap.mart.fyi/</a></p> <p><em>Note: This server is heavily cached on Cloudflare so things may act weird.</em></p> <h2>Installation &amp; Usage</h2> <ol> <li><strong>Install the Mod</strong>: Install the <code>LiveMap</code> mod on both the <strong>Server</strong> and your <strong>Client</strong>.</li> <li><strong>Generate the Colormap</strong>: <ul> <li>After installation, join the server with your client.</li> <li>Run the following command in-game: <pre>/livemap colormap</pre> </li> <li><em>Note: This command sends the necessary color data to the server to begin rendering tiles. Once completed, the mod is technically no longer strictly required on the client side, but it is recommended for updates.</em></li> </ul> </li> <li><strong>Access the Map</strong>: Open your browser and navigate to the map URL (default is usually <code>http://&lt;server-ip&gt;:8080</code> or <code>http://localhost:8080</code> if running locally, check your config).</li> <li><strong>Run a full render</strong>: You'll most likely want to run a full render with <code>/livemap fullrender</code>. As render tasks then are only ran on auto save.&nbsp;</li> </ol> <h2>Known Issues</h2> <ul> <li><span style="text-decoration: line-through;">The translocator marker layer is essentially non-working. It works enough to generate the layer but none of the markers.</span> <strong>Fixed as of 0.1.9</strong></li> <li>The render layer (Standard and Sepia) buttons in the web ui sometimes bug out on first start. This is down to a race condition I'm working on mitigating.&nbsp;</li> <li>Russian translations will lag behind a bit as I move quickly on new features. I don't wanna bug community translators 20 times a day.&nbsp;</li> </ul> <h2>Links &amp; Support</h2> <ul> <li><strong>Source Code</strong>: <a href="https://github.com/mja00/VS-LiveMap-Revival">GitHub Repository</a></li> <li><strong>Issues &amp; Bug Reports</strong>: <a href="https://github.com/mja00/VS-LiveMap-Revival/issues">GitHub Issues</a></li> <li><strong>Wiki/Docs</strong>: <a href="https://mja00.dev/VS-LiveMap-Revival/">Documentation</a> <em>(Work in Progress)</em></li> <li>Get a Vintage Story server with Nodecraft at <a href="https://nodecraft.com/r/mja00">https://nodecraft.com/r/mja00</a> for 30% off your first month. <a href="https://nodecraft.com/r/mja00" target="_blank" rel="noopener"><img src="https://dynamic-assets.nodecraft.com/signedurl/7jY1omym5aKy9GAJ6l/image.jpg?modifications=W3sibmFtZSI6ImNvZGUiLCJ0ZXh0IjoibWphMDAifV0&amp;s=6995ac45d4bdc3ab91249710c83667860d436982f664804a9d34023f0e0e36b7&amp;_gl=1*zsajxx*_gcl_au*MTM5NTI3NTE0My4xNzYwOTc2ODM2*_ga*NzUwNjY0MzIzLjE3NjA5NzY4MzE.*_ga_NPMRRNQ5NF*czE3Njc4OTg0MjMkbzExOCRnMSR0MTc2Nzg5ODQ0MCRqNDMkbDAkaDA." alt="Link to get 30% off your server" width="837" height="80" /></a><small> (Note this link is not monetized, I just wanted to plug my employer lol)</small></li> </ul> <hr /> <p><em>Original mod by BillyGalbreath. Revived and maintained by mja00.</em></p>