common: don't cleanup icons on unregister #115
Merged
Conversation
This file contains 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
jpenilla
reviewed
Sep 16, 2023
common/src/main/java/xyz/jpenilla/squaremap/common/IconRegistry.java
Outdated
Show resolved
Hide resolved
In previous versions, icons files were removed from the web directory when they were unregistered via `IconRegistry.unregister()`. Icons are unregistered when plugins are shut down or removed. When an external web server is in use, map tiles remain available to clients after the game server has stopped—but registered icons do not. The removed icons result in ugly "broken link" images on clients. Instead of removing icon files immediately when they are unregistered, defer the removal until squaremap's next startup. Old icon files will be overwritten with new ones if necessary. See also: <jpenilla#114>
cbs228
force-pushed
the
feature/no_icon_cleanup
branch
from
5991f1b
to
89b3e4c
Compare
jpenilla
changed the title
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.
In previous versions, icons files were removed from the web directory when they were unregistered via
IconRegistry.unregister(). Icons are unregistered when plugins are shut down or removed.When an external web server is in use, map tiles remain available to clients after the game server has stopped—but registered icons do not. The removed icons result in ugly "broken link" images on clients.
Since icons are generally quite small, and are in most cases seldomly swapped out, leaving unused icon files is probably not a big deal. Skip the removal of
images/icon/registeredand all icon files. Old icon files are overwritten as necessary with new ones.Closes #114