Update 1.0.11

- potentially fix color cache error - added /imagemap cleanup command - added /imagemap debuginfo command
SydMontague · May 1, 2023 · b70a163 · b70a163
1 parent 67ed74b
commit b70a163
Show file tree

Hide file tree

Showing 23 changed files with 2,050 additions and 1,902 deletions.
diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml
@@ -1,13 +1,13 @@
-# These are supported funding model platforms
-
-custom: ["paypal.me/sydmontague"] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
-
-# github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-# patreon: # Replace with a single Patreon username
-# open_collective: # Replace with a single Open Collective username
-# ko_fi: # Replace with a single Ko-fi username
-# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-# liberapay: # Replace with a single Liberapay username
-# issuehunt: # Replace with a single IssueHunt username
+# These are supported funding model platforms
+
+custom: ["paypal.me/sydmontague"] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
+
+# github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+# patreon: # Replace with a single Patreon username
+# open_collective: # Replace with a single Open Collective username
+# ko_fi: # Replace with a single Ko-fi username
+# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+# liberapay: # Replace with a single Liberapay username
+# issuehunt: # Replace with a single IssueHunt username
 # otechie: # Replace with a single Otechie username
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
@@ -1,33 +1,33 @@
-# This workflow will build a Java project with Maven
-# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
-
-name: Java CI with Maven
-
-on:
-  push:
-    branches: [ master ]
-
-jobs:
-  build:
-
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up JDK 1.8
-      uses: actions/setup-java@v1
-      with:
-        java-version: 1.8
-    - name: Build with Maven
-      run: |
-        mkdir -p ~/.m2
-        echo "<settings><servers><server><id>github</id><username>${{ github.actor }}</username><password>${{ github.token }}</password></server></servers></settings>" > ~/.m2/settings.xml
-        mvn -B package --file pom.xml
-    - uses: actions/upload-artifact@v1
-      with:
-        name: Package
-        path: target/ImageMaps.jar
-    - name: Publish to GitHub Packages Apache Maven
-      run: mvn deploy
-      env:
-        GITHUB_TOKEN: ${{ github.token }} # GITHUB_TOKEN is the default env for the password
+# This workflow will build a Java project with Maven
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
+
+name: Java CI with Maven
+
+on:
+  push:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up JDK 1.8
+      uses: actions/setup-java@v1
+      with:
+        java-version: 1.8
+    - name: Build with Maven
+      run: |
+        mkdir -p ~/.m2
+        echo "<settings><servers><server><id>github</id><username>${{ github.actor }}</username><password>${{ github.token }}</password></server></servers></settings>" > ~/.m2/settings.xml
+        mvn -B package --file pom.xml
+    - uses: actions/upload-artifact@v1
+      with:
+        name: Package
+        path: target/ImageMaps.jar
+    - name: Publish to GitHub Packages Apache Maven
+      run: mvn deploy
+      env:
+        GITHUB_TOKEN: ${{ github.token }} # GITHUB_TOKEN is the default env for the password
diff --git a/LICENSE b/LICENSE
@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2020 SydMontague
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020 SydMontague
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.MD b/README.MD
@@ -1,99 +1,99 @@
-# ImageMaps
-
-ImageMaps is a plugin for Bukkit  Minecraft servers that enables you to place custom images in your world
-by rendering them onto maps and placing them in item frames.
-
-This can be used to create info graphics, custom paintings and even the appearance of custom textures.
-
-![Example Screenshot](./screenshot.png)
-
-## Installation
-You will need a Server that implements Bukkit 1.13 or newer and the Spigot-API. Some features are only available in newer
-releases. Make sure to use the latest release of your server software before reporting issues.
-
-Put the plugin into your servers `plugins` folder and start it up. A folder for the plugin will be created 
-automatically. You can place your images in the `images` folder inside it.
-
-### Upgrading from versions &lt; 1.0.0
-The plugin should convert your maps.yml automatically. It will attempt to create a backup before doing so, 
-but it is recommended to do one manually as well.
-
-## Usage
-In order for you use place images they must be present in the `images` folder. You can either put them
-there via FTP or just copying it, or by using the plugin's download command, allowing you to access
-images from the Internet.
-
-To place images just run the `/imagemap place` command and right click the block that should be the
-upper left corner of the image (based on your perspective).
-
-Images will by default split into 128x128 pixel sub-images to fit on a map. The image may be scaled via
-command parameters, however **it is recommended to prepare correctly scaled images**.
-
-The color palette of Minecraft maps is very limited, requiring the plugin/Bukkit to convert the input image.
-This will result in your images looking different ingame than the source. The available color table can be
-found here: https://minecraft.gamepedia.com/Map_item_format#Color_table
-
-![Example of color conversion](./colorConversion.png)
-
-The invisible and fixed (-> can't be modified) item frame properties are only available in 1.16+. You can modify them for any item frame
-by using a configurable (default a wooden hoe) items. Right click to toggle visibility and Shift+Right click to 
-toggle the fixed state.
-
-### Commands
-* /imagemap place &lt;filename> [frameInvisible] [frameFixed] [frameGlowing] [size]
-  * Starts the placement process
-  * frameInvisible and frameFixed are only available on 1.16+
-  * frameGlowing is only available on 1.17+
-* /imagemap download &lt;filename> &lt;sourceURL>
-  * downloads an image from the given URL into the `images` folder
-* /imagemap delete &lt;filename>
-  * deletes an image from the `images` folder
-* /imagemap info &lt;filename>
-  * prints info, such as resolution and expected size
-* /imagemap reload &lt;filename>
-  * reloads an image, to be used when the image file changed
-* /imagemap list [page]
-  * lists all images in the `images` folder
-* /imagemap help [command]
-  * prints help for commands
-
-### Permissions
-`imagemaps.*` - grants access to all permissions  
-`imagemaps.place` - grants access to /imagemap place command  
-`imagemaps.download` - grants access to /imagemap download command  
-`imagemaps.delete` - grants access to /imagemap delete command  
-`imagemaps.info` - grants access to /imagemap info command  
-`imagemaps.list` - grants access to /imagemap list command  
-`imagemaps.reload` - grants access to /imagemap reload command  
-`imagemaps.help` - grants access to /imagemap help command  
-`imagemaps.toggleFixed` - allows to toggle the "fixed" state of frames with a wooden hoe  
-`imagemaps.toggleVisible` - allows to toggle the "visible" state of frames with a wooden hoe  
-
-All permissions are default true for OPs.
-
-
-## Maven
-You will need to [configure your environment to access GitHub repositories](https://docs.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages).
-
-```
-<repository>
-  <id>github</id>
-  <name>ImageMaps repository</name>
-  <url>https://maven.pkg.github.com/SydMontague/ImageMaps</url>
-</repository>
-```
-```
-<dependency>
-  <groupId>net.craftcitizen</groupId>
-  <artifactId>imagemaps</artifactId>
-  <version>1.0.1</version>
-</dependency>
-```
-
-## Contact 
-* Discord: SydMontague#8056
-* directly on GitHub
-* E-Mail: sydmontague@web.de
-* Spigot: https://www.spigotmc.org/members/sydmontague.37699/
-
+# ImageMaps
+
+ImageMaps is a plugin for Bukkit  Minecraft servers that enables you to place custom images in your world
+by rendering them onto maps and placing them in item frames.
+
+This can be used to create info graphics, custom paintings and even the appearance of custom textures.
+
+![Example Screenshot](./screenshot.png)
+
+## Installation
+You will need a Server that implements Bukkit 1.13 or newer and the Spigot-API. Some features are only available in newer
+releases. Make sure to use the latest release of your server software before reporting issues.
+
+Put the plugin into your servers `plugins` folder and start it up. A folder for the plugin will be created 
+automatically. You can place your images in the `images` folder inside it.
+
+### Upgrading from versions &lt; 1.0.0
+The plugin should convert your maps.yml automatically. It will attempt to create a backup before doing so, 
+but it is recommended to do one manually as well.
+
+## Usage
+In order for you use place images they must be present in the `images` folder. You can either put them
+there via FTP or just copying it, or by using the plugin's download command, allowing you to access
+images from the Internet.
+
+To place images just run the `/imagemap place` command and right click the block that should be the
+upper left corner of the image (based on your perspective).
+
+Images will by default split into 128x128 pixel sub-images to fit on a map. The image may be scaled via
+command parameters, however **it is recommended to prepare correctly scaled images**.
+
+The color palette of Minecraft maps is very limited, requiring the plugin/Bukkit to convert the input image.
+This will result in your images looking different ingame than the source. The available color table can be
+found here: https://minecraft.gamepedia.com/Map_item_format#Color_table
+
+![Example of color conversion](./colorConversion.png)
+
+The invisible and fixed (-> can't be modified) item frame properties are only available in 1.16+. You can modify them for any item frame
+by using a configurable (default a wooden hoe) items. Right click to toggle visibility and Shift+Right click to 
+toggle the fixed state.
+
+### Commands
+* /imagemap place &lt;filename> [frameInvisible] [frameFixed] [frameGlowing] [size]
+  * Starts the placement process
+  * frameInvisible and frameFixed are only available on 1.16+
+  * frameGlowing is only available on 1.17+
+* /imagemap download &lt;filename> &lt;sourceURL>
+  * downloads an image from the given URL into the `images` folder
+* /imagemap delete &lt;filename>
+  * deletes an image from the `images` folder
+* /imagemap info &lt;filename>
+  * prints info, such as resolution and expected size
+* /imagemap reload &lt;filename>
+  * reloads an image, to be used when the image file changed
+* /imagemap list [page]
+  * lists all images in the `images` folder
+* /imagemap help [command]
+  * prints help for commands
+
+### Permissions
+`imagemaps.*` - grants access to all permissions  
+`imagemaps.place` - grants access to /imagemap place command  
+`imagemaps.download` - grants access to /imagemap download command  
+`imagemaps.delete` - grants access to /imagemap delete command  
+`imagemaps.info` - grants access to /imagemap info command  
+`imagemaps.list` - grants access to /imagemap list command  
+`imagemaps.reload` - grants access to /imagemap reload command  
+`imagemaps.help` - grants access to /imagemap help command  
+`imagemaps.toggleFixed` - allows to toggle the "fixed" state of frames with a wooden hoe  
+`imagemaps.toggleVisible` - allows to toggle the "visible" state of frames with a wooden hoe  
+
+All permissions are default true for OPs.
+
+
+## Maven
+You will need to [configure your environment to access GitHub repositories](https://docs.github.com/en/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages).
+
+```
+<repository>
+  <id>github</id>
+  <name>ImageMaps repository</name>
+  <url>https://maven.pkg.github.com/SydMontague/ImageMaps</url>
+</repository>
+```
+```
+<dependency>
+  <groupId>net.craftcitizen</groupId>
+  <artifactId>imagemaps</artifactId>
+  <version>1.0.1</version>
+</dependency>
+```
+
+## Contact 
+* Discord: SydMontague#8056
+* directly on GitHub
+* E-Mail: sydmontague@web.de
+* Spigot: https://www.spigotmc.org/members/sydmontague.37699/
+
 This plugin has been developed for the [CraftCitizen](https://craftcitizen.net) survival Minecraft server.