Skip to content

Latest commit

 

History

History
92 lines (78 loc) · 5.03 KB

README.md

File metadata and controls

92 lines (78 loc) · 5.03 KB
Raw

ImageOnMap



✔️ Simple usage, without external convertors
✔️ Supporting both .png and .jpg image formats
✔️ Image is automatically resized to fit item frame
✔️ Supports last PocketMine API version

Commands

  • Plugin implements command /image with aliases /img and /iom.
  • To use this command, permission imageonmap.command is needed.
  • This command can be used only in game.
  • There are implemented these subcommands:
Sub-Command Description
/img help Shows all the available subcommands
/img list Displays all the available images found in /plugin_data/ImageOnMap/images/* path.
/img obtain <image> [<xChunkCount> <yChunkCount> <x> <y>] Obtains specific image (or it's specific part) from file as map item.

Chunk count argument represents to how many parts should be the image split. X and Y coordinates represents which part of that chunked image will be given to player's inventory.

Aliases: /img o
/img place <image> Places the whole images on to item frames in selected area.

To place an image properly, first execute the command (/img p image). Afterwards, break the first corner of the target position and then break the block to select second position. The image will be placed automatically.

Aliases: /img p

API

  • Obtaining plugin instance
$api = \czechpmdevs\imageonmap\ImageOnMap::getInstance();
  • Loading image from file
// This method caches the map and returns its id. Afterwards the id can be used to obtain map item.
$id = $api->getImageFromFile(
	file: "path/to/image.png",
	xChunkCount: 1,
	yChunkCount: 1,
	xOffset: 0,
	yOffset: 0
);
  • Obtaining Map item, assigning id & giving it to player
/** @var \czechpmdevs\imageonmap\item\FilledMap $map */
$map = (FilledMap::get())->setMapId($id);
/** @var \pocketmine\player\Player $player */
$player->getInventory()->addItem($map);

💡 License

ImageOnMap - Easy to use PocketMine plugin, which allows loading images on maps
Copyright (C) 2021 - 2022 CzechPMDevs

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.