IconForge: DMI Generation, Code Reorganization, Improved Caching, Cleaner I/O #213
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
vinylspiders
reviewed
May 1, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR updates the IconForge system by adding arbitrary icon generation with support for DMI output, improved caching using Arc and DashMap, and cleaner I/O handling. Key changes include new Rust modules for spritesheet generation, image caching, and blending, along with updated DM macros and documentation to support the new DMI and flatten parameters.
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/iconforge/spritesheet.rs | Introduces new structures for spritesheet results with DMI support. |
| src/iconforge/image_cache.rs | Implements enhanced caching for UniversalIcon data and DMI file parsing. |
| src/iconforge/byond.rs | Adds DM bindings for synchronous and asynchronous icon generation functions. |
| src/iconforge/blending.rs | Provides blending operations with a variety of blend modes for RGBA colors. |
| dmsrc/iconforge.dm | Updates macros and documentation to include new generate_dmi and flatten flags. |
Comments suppressed due to low confidence (1)
dmsrc/iconforge.dm:6
- Typo in documentation: 'heplful' should be corrected to 'helpful'.
/// These hashes can be heplful for 'smart' caching (see rustg_iconforge_cache_valid), but require extra computation.
ZeWaka
approved these changes
Jun 29, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What This Does
sprite_namethat caused the error, rather than saying "N/A, in final generation stage".Breaking DM change: add
, FALSE, TRUEargument to the end of existing calls torustg_iconforge_generate()orrustg_iconforge_generate_async()Breaking DM change: The default arguments of the commonly used
uni_iconAPI need to be adjusted so that dir and frame are nullArbitrary Icon Generation
It's now technically possible to generate just about any icon that the game can make (excluding certain special operations) with just the uni_icon system and
rustg_iconforge_generate(), because it now supports multi-dir and animated icons. However, the main benefit of IconForge is still parallelization and caching.I got this idea because it would make tgstation/tgstation#90940 run significantly faster with very little effort.
I tested this using the linked TG PR with the following method replacement:
The output was exactly as expected.
I did some tracy profiling, and it's actually faster now, due to changes in how caching and I/O works