From 1b90fb5e293a2106debe986016ea95bbe42f1494 Mon Sep 17 00:00:00 2001 From: Alexandre Date: Sun, 28 Aug 2016 00:45:38 +0200 Subject: [PATCH] Updated README with useful content Now this thing is actually useful (it took three years (THREE YEARS)) --- README.md | 97 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 97 insertions(+) diff --git a/README.md b/README.md index 13e2a3c..8a82774 100644 --- a/README.md +++ b/README.md @@ -2,3 +2,100 @@ ImageOnMap ========== Repo for ImageOnMap, a bukkit plugin + + +## Features + +ImageOnMap allows you to load a picture from the Internet to a Minecraft map. + +- Loads an image from a URL onto a map. PNG, JPEG and GIF are supported. +- These images will be saved on your server and reloaded at restart. +- Big pictures will be cut automatically into several parts! As example a 1024x1024 picture will be cut in 16 maps. +- Your image will be centered. +- You can put your map in an item frame. + +This plugin is a free software lisensed under the GNU General Public License (version 3 or above). The source code is published on GitHub. You can also get unstable development builds here. + + +## Quick guide + +- Ensure that you have a free slot in your inventory, as ImageOnMap will give you a map. +- Type `/tomap URL`, where URL is a link to the picture you want to render (see the section below). +- Enjoy your picture! You can place it in an item frame to make a nice poster if you want. + + +## Commands and Permissions + +### `/tomap ` + +Renders an image and gives a map to the player with it. + +- This command can only be used by a player. +- The link must be complete, do not forget that the chat limit is 240 characters. +- You can use an URL shortener like tinyURL or bitly. +- If you want a picture in one map, type resize after the link. +- Permission: `imageonmap.userender` + + +### `/maps` + +Opens a GUI to see, retrieve and manage the user's maps. + +- This command can only be used by a player. +- Opens a GUI listing all the maps in a pagnated 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). + + +### `/maptool ` + +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 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. + + + +##Configuration + +```yaml +# Plugin language. Empty: system language. +# Available: en_US (default, fallback) and fr_FR. +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 +``` + +## New features in the 3.0 version + +The 3.0 release is a complete rewrite of the original ImageOnMap plugin, now based on zLib, which adds many feature and fixes many bugs. + +This new version is not compatible with the older ones, so your older maps will not be loaded. Run the `/maptool migrate` command (as op or in console) in order to get them back in this new version. + +You will find amongst the new features: + +- New Splatter maps, making it easy to deploy and remove big posters in one click ! +- No more item tags when maps are put in item frames ! +- Internationalization support (only french and english are supported for now, contributions are welcome) +- Map Quotas (for players and the whole server) +- A new map Manager (based on an inventory interface), to list, rename, get and delete your maps +- Improvements on the commands system (integrated help and autocompletion) +- Asynchronous maps rendering (your server won't freeze anymore when rendering big maps, and you can queue multiple map renderings !) +- UUID management (which requires to run `/maptool migrate`) + + + +## Data collection + +We use metrics to collect basic informations about the usage of this plugin. This can be disabled by setting "collect-data" to false in config.yml.