Skip to content

Commit b70a163

Browse files
SydMontagueSydMontague
committed
Update 1.0.11
- potentially fix color cache error - added /imagemap cleanup command - added /imagemap debuginfo command
1 parent 67ed74b commit b70a163

23 files changed

Lines changed: 2050 additions & 1902 deletions

‎.github/FUNDING.yml‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# These are supported funding model platforms
2-
3-
custom: ["paypal.me/sydmontague"] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
4-
5-
# github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
6-
# patreon: # Replace with a single Patreon username
7-
# open_collective: # Replace with a single Open Collective username
8-
# ko_fi: # Replace with a single Ko-fi username
9-
# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
10-
# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
11-
# liberapay: # Replace with a single Liberapay username
12-
# issuehunt: # Replace with a single IssueHunt username
1+
# These are supported funding model platforms
2+
3+
custom: ["paypal.me/sydmontague"] # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
4+
5+
# github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
6+
# patreon: # Replace with a single Patreon username
7+
# open_collective: # Replace with a single Open Collective username
8+
# ko_fi: # Replace with a single Ko-fi username
9+
# tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
10+
# community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
11+
# liberapay: # Replace with a single Liberapay username
12+
# issuehunt: # Replace with a single IssueHunt username
1313
# otechie: # Replace with a single Otechie username

‎.github/workflows/maven.yml‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
# This workflow will build a Java project with Maven
2-
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
3-
4-
name: Java CI with Maven
5-
6-
on:
7-
push:
8-
branches: [ master ]
9-
10-
jobs:
11-
build:
12-
13-
runs-on: ubuntu-latest
14-
15-
steps:
16-
- uses: actions/checkout@v2
17-
- name: Set up JDK 1.8
18-
uses: actions/setup-java@v1
19-
with:
20-
java-version: 1.8
21-
- name: Build with Maven
22-
run: |
23-
mkdir -p ~/.m2
24-
echo "<settings><servers><server><id>github</id><username>${{ github.actor }}</username><password>${{ github.token }}</password></server></servers></settings>" > ~/.m2/settings.xml
25-
mvn -B package --file pom.xml
26-
- uses: actions/upload-artifact@v1
27-
with:
28-
name: Package
29-
path: target/ImageMaps.jar
30-
- name: Publish to GitHub Packages Apache Maven
31-
run: mvn deploy
32-
env:
33-
GITHUB_TOKEN: ${{ github.token }} # GITHUB_TOKEN is the default env for the password
1+
# This workflow will build a Java project with Maven
2+
# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
3+
4+
name: Java CI with Maven
5+
6+
on:
7+
push:
8+
branches: [ master ]
9+
10+
jobs:
11+
build:
12+
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- uses: actions/checkout@v2
17+
- name: Set up JDK 1.8
18+
uses: actions/setup-java@v1
19+
with:
20+
java-version: 1.8
21+
- name: Build with Maven
22+
run: |
23+
mkdir -p ~/.m2
24+
echo "<settings><servers><server><id>github</id><username>${{ github.actor }}</username><password>${{ github.token }}</password></server></servers></settings>" > ~/.m2/settings.xml
25+
mvn -B package --file pom.xml
26+
- uses: actions/upload-artifact@v1
27+
with:
28+
name: Package
29+
path: target/ImageMaps.jar
30+
- name: Publish to GitHub Packages Apache Maven
31+
run: mvn deploy
32+
env:
33+
GITHUB_TOKEN: ${{ github.token }} # GITHUB_TOKEN is the default env for the password

‎LICENSE‎

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
MIT License
2-
3-
Copyright (c) 2020 SydMontague
4-
5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
11-
12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
14-
15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE.
1+
MIT License
2+
3+
Copyright (c) 2020 SydMontague
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.MD‎

Lines changed: 98 additions & 98 deletions
Original file line numberDiff line numberDiff line change
@@ -1,99 +1,99 @@
1-
# ImageMaps
2-
3-
ImageMaps is a plugin for Bukkit Minecraft servers that enables you to place custom images in your world
4-
by rendering them onto maps and placing them in item frames.
5-
6-
This can be used to create info graphics, custom paintings and even the appearance of custom textures.
7-
8-
![Example Screenshot](./screenshot.png)
9-
10-
## Installation
11-
You will need a Server that implements Bukkit 1.13 or newer and the Spigot-API. Some features are only available in newer
12-
releases. Make sure to use the latest release of your server software before reporting issues.
13-
14-
Put the plugin into your servers `plugins` folder and start it up. A folder for the plugin will be created
15-
automatically. You can place your images in the `images` folder inside it.
16-
17-
### Upgrading from versions &lt; 1.0.0
18-
The plugin should convert your maps.yml automatically. It will attempt to create a backup before doing so,
19-
but it is recommended to do one manually as well.
20-
21-
## Usage
22-
In order for you use place images they must be present in the `images` folder. You can either put them
23-
there via FTP or just copying it, or by using the plugin's download command, allowing you to access
24-
images from the Internet.
25-
26-
To place images just run the `/imagemap place` command and right click the block that should be the
27-
upper left corner of the image (based on your perspective).
28-
29-
Images will by default split into 128x128 pixel sub-images to fit on a map. The image may be scaled via
30-
command parameters, however **it is recommended to prepare correctly scaled images**.
31-
32-
The color palette of Minecraft maps is very limited, requiring the plugin/Bukkit to convert the input image.
33-
This will result in your images looking different ingame than the source. The available color table can be
34-
found here: https://minecraft.gamepedia.com/Map_item_format#Color_table
35-
36-
![Example of color conversion](./colorConversion.png)
37-
38-
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
39-
by using a configurable (default a wooden hoe) items. Right click to toggle visibility and Shift+Right click to
40-
toggle the fixed state.
41-
42-
### Commands
43-
* /imagemap place &lt;filename> [frameInvisible] [frameFixed] [frameGlowing] [size]
44-
* Starts the placement process
45-
* frameInvisible and frameFixed are only available on 1.16+
46-
* frameGlowing is only available on 1.17+
47-
* /imagemap download &lt;filename> &lt;sourceURL>
48-
* downloads an image from the given URL into the `images` folder
49-
* /imagemap delete &lt;filename>
50-
* deletes an image from the `images` folder
51-
* /imagemap info &lt;filename>
52-
* prints info, such as resolution and expected size
53-
* /imagemap reload &lt;filename>
54-
* reloads an image, to be used when the image file changed
55-
* /imagemap list [page]
56-
* lists all images in the `images` folder
57-
* /imagemap help [command]
58-
* prints help for commands
59-
60-
### Permissions
61-
`imagemaps.*` - grants access to all permissions
62-
`imagemaps.place` - grants access to /imagemap place command
63-
`imagemaps.download` - grants access to /imagemap download command
64-
`imagemaps.delete` - grants access to /imagemap delete command
65-
`imagemaps.info` - grants access to /imagemap info command
66-
`imagemaps.list` - grants access to /imagemap list command
67-
`imagemaps.reload` - grants access to /imagemap reload command
68-
`imagemaps.help` - grants access to /imagemap help command
69-
`imagemaps.toggleFixed` - allows to toggle the "fixed" state of frames with a wooden hoe
70-
`imagemaps.toggleVisible` - allows to toggle the "visible" state of frames with a wooden hoe
71-
72-
All permissions are default true for OPs.
73-
74-
75-
## Maven
76-
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).
77-
78-
```
79-
<repository>
80-
<id>github</id>
81-
<name>ImageMaps repository</name>
82-
<url>https://maven.pkg.github.com/SydMontague/ImageMaps</url>
83-
</repository>
84-
```
85-
```
86-
<dependency>
87-
<groupId>net.craftcitizen</groupId>
88-
<artifactId>imagemaps</artifactId>
89-
<version>1.0.1</version>
90-
</dependency>
91-
```
92-
93-
## Contact
94-
* Discord: SydMontague#8056
95-
* directly on GitHub
96-
* E-Mail: sydmontague@web.de
97-
* Spigot: https://www.spigotmc.org/members/sydmontague.37699/
98-
1+
# ImageMaps
2+
3+
ImageMaps is a plugin for Bukkit Minecraft servers that enables you to place custom images in your world
4+
by rendering them onto maps and placing them in item frames.
5+
6+
This can be used to create info graphics, custom paintings and even the appearance of custom textures.
7+
8+
![Example Screenshot](./screenshot.png)
9+
10+
## Installation
11+
You will need a Server that implements Bukkit 1.13 or newer and the Spigot-API. Some features are only available in newer
12+
releases. Make sure to use the latest release of your server software before reporting issues.
13+
14+
Put the plugin into your servers `plugins` folder and start it up. A folder for the plugin will be created
15+
automatically. You can place your images in the `images` folder inside it.
16+
17+
### Upgrading from versions &lt; 1.0.0
18+
The plugin should convert your maps.yml automatically. It will attempt to create a backup before doing so,
19+
but it is recommended to do one manually as well.
20+
21+
## Usage
22+
In order for you use place images they must be present in the `images` folder. You can either put them
23+
there via FTP or just copying it, or by using the plugin's download command, allowing you to access
24+
images from the Internet.
25+
26+
To place images just run the `/imagemap place` command and right click the block that should be the
27+
upper left corner of the image (based on your perspective).
28+
29+
Images will by default split into 128x128 pixel sub-images to fit on a map. The image may be scaled via
30+
command parameters, however **it is recommended to prepare correctly scaled images**.
31+
32+
The color palette of Minecraft maps is very limited, requiring the plugin/Bukkit to convert the input image.
33+
This will result in your images looking different ingame than the source. The available color table can be
34+
found here: https://minecraft.gamepedia.com/Map_item_format#Color_table
35+
36+
![Example of color conversion](./colorConversion.png)
37+
38+
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
39+
by using a configurable (default a wooden hoe) items. Right click to toggle visibility and Shift+Right click to
40+
toggle the fixed state.
41+
42+
### Commands
43+
* /imagemap place &lt;filename> [frameInvisible] [frameFixed] [frameGlowing] [size]
44+
* Starts the placement process
45+
* frameInvisible and frameFixed are only available on 1.16+
46+
* frameGlowing is only available on 1.17+
47+
* /imagemap download &lt;filename> &lt;sourceURL>
48+
* downloads an image from the given URL into the `images` folder
49+
* /imagemap delete &lt;filename>
50+
* deletes an image from the `images` folder
51+
* /imagemap info &lt;filename>
52+
* prints info, such as resolution and expected size
53+
* /imagemap reload &lt;filename>
54+
* reloads an image, to be used when the image file changed
55+
* /imagemap list [page]
56+
* lists all images in the `images` folder
57+
* /imagemap help [command]
58+
* prints help for commands
59+
60+
### Permissions
61+
`imagemaps.*` - grants access to all permissions
62+
`imagemaps.place` - grants access to /imagemap place command
63+
`imagemaps.download` - grants access to /imagemap download command
64+
`imagemaps.delete` - grants access to /imagemap delete command
65+
`imagemaps.info` - grants access to /imagemap info command
66+
`imagemaps.list` - grants access to /imagemap list command
67+
`imagemaps.reload` - grants access to /imagemap reload command
68+
`imagemaps.help` - grants access to /imagemap help command
69+
`imagemaps.toggleFixed` - allows to toggle the "fixed" state of frames with a wooden hoe
70+
`imagemaps.toggleVisible` - allows to toggle the "visible" state of frames with a wooden hoe
71+
72+
All permissions are default true for OPs.
73+
74+
75+
## Maven
76+
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).
77+
78+
```
79+
<repository>
80+
<id>github</id>
81+
<name>ImageMaps repository</name>
82+
<url>https://maven.pkg.github.com/SydMontague/ImageMaps</url>
83+
</repository>
84+
```
85+
```
86+
<dependency>
87+
<groupId>net.craftcitizen</groupId>
88+
<artifactId>imagemaps</artifactId>
89+
<version>1.0.1</version>
90+
</dependency>
91+
```
92+
93+
## Contact
94+
* Discord: SydMontague#8056
95+
* directly on GitHub
96+
* E-Mail: sydmontague@web.de
97+
* Spigot: https://www.spigotmc.org/members/sydmontague.37699/
98+
9999
This plugin has been developed for the [CraftCitizen](https://craftcitizen.net) survival Minecraft server.

0 commit comments

Comments
 (0)