{"id":20256335,"url":"https://github.com/czechpmdevs/imageonmap","last_synced_at":"2025-04-11T00:21:52.715Z","repository":{"id":38296371,"uuid":"400605818","full_name":"CzechPMDevs/ImageOnMap","owner":"CzechPMDevs","description":"🖼️ Easy to use PocketMine plugin, which allows loading images on maps","archived":false,"fork":false,"pushed_at":"2023-07-05T17:38:24.000Z","size":119,"stargazers_count":17,"open_issues_count":5,"forks_count":9,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-24T21:06:22.517Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CzechPMDevs.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-27T18:46:49.000Z","updated_at":"2025-01-12T07:49:46.000Z","dependencies_parsed_at":"2023-02-09T20:30:59.810Z","dependency_job_id":null,"html_url":"https://github.com/CzechPMDevs/ImageOnMap","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CzechPMDevs%2FImageOnMap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CzechPMDevs%2FImageOnMap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CzechPMDevs%2FImageOnMap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CzechPMDevs%2FImageOnMap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CzechPMDevs","download_url":"https://codeload.github.com/CzechPMDevs/ImageOnMap/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248318928,"owners_count":21083751,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T10:46:14.530Z","updated_at":"2025-04-11T00:21:52.693Z","avatar_url":"https://github.com/CzechPMDevs.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003ch1\u003eImageOnMap\u003c/h1\u003e \n\u003ca href=\"https://poggit.pmmp.io/ci/CzechPMDevs/ImageOnMap/ImageOnMap\"\u003e  \n    \u003cimg src=\"https://poggit.pmmp.io/ci.shield/CzechPMDevs/ImageOnMap/ImageOnMap?style=flat-square\"\u003e  \n\u003c/a\u003e  \n\u003ca href=\"https://discord.gg/uwBf2jS\"\u003e  \n    \u003cimg src=\"https://img.shields.io/discord/365202594932719616.svg?style=flat-square\"\u003e  \n\u003c/a\u003e  \n\u003ca href=\"https://github.com/CzechPMDevs/ImageOnMap/releases\"\u003e  \n    \u003cimg src=\"https://img.shields.io/github/release/CzechPMDevs/ImageOnMap.svg?style=flat-square\"\u003e  \n\u003c/a\u003e  \n\u003ca href=\"https://github.com/CzechPMDevs/ImageOnMap/releases\"\u003e  \n    \u003cimg src=\"https://img.shields.io/github/downloads/CzechPMDevs/ImageOnMap/total.svg?style=flat-square\"\u003e  \n\u003c/a\u003e\n\u003ca href=\"https://github.com/CzechPMDevs/ImageOnMap/blob/master/LICENSE\"\u003e  \n    \u003cimg src=\"https://img.shields.io/github/license/CzechPMDevs/ImageOnMap.svg?style=flat-square\"\u003e  \n\u003c/a\u003e  \n\u003ca href=\"https://poggit.pmmp.io/p/ImageOnMap\"\u003e  \n    \u003cimg src=\"https://poggit.pmmp.io/shield.downloads/ImageOnMap?style=flat-square\"\u003e  \n\u003c/a\u003e\n\u003cbr\u003e\u003cbr\u003e  \n✔️ Simple usage, without external convertors\n\u003cbr\u003e  \n✔️ Supporting both .png and .jpg image formats\n\u003cbr\u003e  \n✔️ Image is automatically resized to fit item frame\n\u003cbr\u003e\n✔️ Supports last PocketMine API version\n\u003cbr\u003e\n\n## Commands\n\n- Plugin implements command `/image` with aliases `/img` and `/iom`.\n- To use this command, **permission** `imageonmap.command` **is needed**.\n- This command can be used only in game.\n  \u003cbr\u003e\n- There are implemented these subcommands:\n\n| **Sub-Command**                                               | **Description**                                                                                                                                                                                                                                                                                                         |\n|---------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| /img help                                                     | Shows all the available subcommands                                                                                                                                                                                                                                                                                     |\n| /img list                                                     | Displays all the available images found in `/plugin_data/ImageOnMap/images/*` path.                                                                                                                                                                                                                                     |\n| /img obtain `\u003cimage\u003e` `[\u003cxChunkCount\u003e \u003cyChunkCount\u003e \u003cx\u003e \u003cy\u003e]` | Obtains specific image (or it's specific part) from file as map item.\u003cbr\u003e\u003cbr\u003eChunk 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.\u003cbr\u003e\u003cbr\u003eAliases: /img o                                   |\n| /img place `\u003cimage\u003e`                                          | Places the whole images on to item frames in selected area.\u003cbr\u003e\u003cbr\u003eTo 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.\u003cbr\u003e\u003cbr\u003eAliases: /img p |\n\n## API\n\n- Obtaining plugin instance\n\n```php\n$api = \\czechpmdevs\\imageonmap\\ImageOnMap::getInstance();\n```\n\n- Loading image from file\n\n```php\n// This method caches the map and returns its id. Afterwards the id can be used to obtain map item.\n$id = $api-\u003egetImageFromFile(\n\tfile: \"path/to/image.png\",\n\txChunkCount: 1,\n\tyChunkCount: 1,\n\txOffset: 0,\n\tyOffset: 0\n);\n```\n\n- Obtaining Map item, assigning id \u0026 giving it to player\n\n```php\n/** @var \\czechpmdevs\\imageonmap\\item\\FilledMap $map */\n$map = (FilledMap::get())-\u003esetMapId($id);\n/** @var \\pocketmine\\player\\Player $player */\n$player-\u003egetInventory()-\u003eaddItem($map);\n```\n\n## 💡 License\n```\nImageOnMap - Easy to use PocketMine plugin, which allows loading images on maps\nCopyright (C) 2021 - 2022 CzechPMDevs\n\nThis program is free software: you can redistribute it and/or modify\nit under the terms of the GNU General Public License as published by\nthe Free Software Foundation, either version 3 of the License, or\n(at your option) any later version.\n\nThis program is distributed in the hope that it will be useful,\nbut WITHOUT ANY WARRANTY; without even the implied warranty of\nMERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\nGNU General Public License for more details.\n\nYou should have received a copy of the GNU General Public License\nalong with this program.  If not, see \u003chttps://www.gnu.org/licenses/\u003e.\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fczechpmdevs%2Fimageonmap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fczechpmdevs%2Fimageonmap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fczechpmdevs%2Fimageonmap/lists"}