Upstream
/
ImageOnMap
mirror of https://github.com/zDevelopers/ImageOnMap.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Updated documentation (#157) 

Co-authored-by: Vlammar <valentin.jabre@gmail.com>
This commit is contained in:
Vlammar 2021-04-11 02:34:57 +02:00 committed by GitHub
parent d072c5b4c6
commit e7467584c8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 57 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
README.md
View File

@ -39,62 +39,88 @@ Renders an image and gives a map to the player with it.
- Permission: `imageonmap.new` (or `imageonmap.userender`—legacy, but will be kept in the plugin).
### `/maps`
### `/maps [PlayerName]`
Opens a GUI to see, retrieve and manage the user's maps.
Opens a GUI to see, retrieve and manage the user's maps, can be used to see other user's maps.
- This command can only be used by a player.
- Opens a GUI listing all the maps in a pagnated view.
- Opens a GUI listing all the maps in a paginated view.
- A book is displayed too to see some usage statistics (maps created, quotas).
- An user can retrieve a map by left-clicking it, or manage it by right-clicking.
- Maps can be renamed (for organization), deleted (but they won't render in game anymore!), or partially retrieved (for posters maps containing more than one map).
- Permission: `imageonmap.list`, plus `imageonmap.get`, `imageonmap.rename` and `imageonmap.delete` for actions into the GUI.
- Permissions: `imageonmap.explore`,`imageonmap.list`, plus `imageonmap.get`, `imageonmap.rename` and `imageonmap.delete` for actions into the GUI, for moderation usage`imageonmap.exploreother`, `imageonmap.listother`,`imageonmap.getother`,`imageonmap.deleteother`.
### `/givemap PlayerName [PlayerFrom]:<MapName>`
### `/maptool <new|list|get|delete|explore|migrate>`
Give to a player a map from a player map store (if not specified will take from the player map store).
- Can be used by a command block and by server console (but you need to specify PlayerFrom)
Examples:
- `/givemap Vlammar "A very cool map name"` Will give the map named "A very cool map name" to the player Vlammar
- `/givemap Vlammar AmauryPi:"A very cool map name"` Same as above but will use AmauryPi's map store instead of the one of the player that runs the command
- Permission: `imageonmap.give`
### `/maptool update [PlayerName]:<MapName> <new url> [stretched|covered] `
Update a specified map (the field PlayerName is optional, by default it will look in the command sender store)
- Can be used by a command block and by server console, if so the field Playername becomes mandatory
Examples:
- `/maptool update "A very cool map name" https://www.numerama.com/wp-content/uploads/2020/09/never-gonna-give-you-up-clip-1024x581.jpg ` Will update the map named "A very cool map name"
- `/maptool update AmauryPi:"A very cool map name" https://www.numerama.com/wp-content/uploads/2020/09/never-gonna-give-you-up-clip-1024x581.jpg covered` Will update AmauryPi's map and set it to covered
- Permissions: `imageonmap.update`, `imageonmap.updateother`
### `/maptool <new|list|get|delete|explore|update|give|rename|migrate>`
Main command to manage the maps. The less used in everyday usage, too.
- The commands names are pretty obvious.
- `/maptool new` is an alias of `/tomap`.
- `/maptool explore` is an alias of `/maps`.
- `/maptool give` is an alias of `/givemap`.
- `/maptool update` allow to update a specific map.
- `/maptool migrate` migrates the old maps when you upgrade from IoM <= 2.7 to IoM 3.0. You HAVE TO execute this command to retrieve all maps when you do such a migration.
- the followings commands come with an extra permission `imageonmap.CMDNAMEother`:
- `/maptool list|get|delete|explore|update`
- Permissions:
- `imageonmap.new` for `/maptool new`;
- `imageonmap.list` for both `/maptool list` and `/maptool explore`;
- `imageonmap.get` for `/maptool get`;
- `imageonmap.delete` for `/maptool delete`;
- `imageonmap.administrative` for `/maptool migrate`.
- `imageonmap.explore` for `/maptool explore`;
- `imageonmap.update` for `/maptool update`;
- `imageonmap.give` for `/maptool give`;
### About the permissions
All permissions are by default granted to everyone, with the exception of `imageonmap.administrative`. We believe that in most cases, servers administrators want to give the availability to create images on maps to every player.
All permissions are by default granted to everyone, with the exception of `imageonmap.administrative`, `imageonmap.give` and the ones that used the suffix `other` . We believe that in most cases, servers administrators want to give the availability to create images on maps to every player.
Negate a permission using a plugin manager to remove it, if you want to restrict this possibility to a set of users.
You can grant `imageonmap.*` to users, as this permission is a shortcut for all _user_ permissions (excluding `imageonmap.administrative`).
You can grant `imageonmap.*` to users, as this permission is a shortcut for all _user_ permissions (excluding `imageonmap.administrative` , `imageonmap.give` and every permission with the prefix `other` that are intended for moderation usage).
## Configuration
```yaml
# Plugin language. Empty: system language.
# Available: en-US (default, fallback), fr-FR, ru-RU, de-DE.
# Available: en-US (default, fallback), fr-FR, ru-RU, de-DE, zh-CN, ja-JP.
lang:
# Allows collection of anonymous statistics on plugin environment and usage
# The statistics are publicly visible here: http://mcstats.org/plugin/ImageOnMap
collect-data: true
# Images rendered on maps consume Minecraft maps ID, and there are only 32 767 of them.
# You can limit the maximum number of maps a player, or the whole server, can use with ImageOnMap.
# 0 means unlimited.
map-global-limit: 0
map-player-limit: 0
# Maximum size in pixels for an image to be. 0 is unlimited.
limit-map-size-x: 0
limit-map-size-y: 0
# Should the full image be saved when a map is rendered?
save-full-image: false
```
@ -140,6 +166,28 @@ upcoming Minecraft 1.16 version, an update will add compatibility soon after its
- When a player place a splatter map, other players in the same area see it entirely, including the bottom-left corner.
- Added Russian and German translations (thx to Danechek and squeezer).
### 4.1 — Moderation Update
Moderation Update gives mods or admins commands to see maps for other players, to give maps, but also to update maps already placed in the world. You can also use ImageOnMap commands from the console or from command blocks, opening a whole new realm of automation around ImageOnMap (read: commands executed from skripts and data-packs should work).
We also fixed some bugs that were reported by lots of people.
This version is only compatible with Minecraft 1.15+.
- Added /maptool update to change the image attached to a map.
- Added /givemap to give a map of a specific player to another.
- All command can now be executed for other players. As example, /maps username will allow you to see all username maps.
- You can now use ImageOnMap commands from command blocks or from the console.
- Commands now support map name between quotes: "A nice name to have for a map".
- Added /maptool rename if you don't want or cannot use the GUI.
- Size limit (in frame).
- Bug fixes & optimizations.
- Various optimizations.
- Fixed AWT memory leak—can happen if you do a lot of 50x50 renders.
- /maptool list no longer throw an exception.
- Fixed an issue where the bottom left map that not render like it should.
- Fixed the gui rename issue that was the cause of inventory loss.
## Data collection