Skip to content

feat: add image maps to the plugin api - #3

Merged
NaySurGithub merged 2 commits into
mainfrom
feat/image-maps
Nov 8, 2026
Merged

NaySurGithub merged 2 commits into
mainfrom
feat/image-maps

Conversation

@NaySurGithub

@NaySurGithub NaySurGithub commented Nov 8, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Image maps for native plugins: show any image on vanilla maps hung in item frames, with no client mod. API version bumped to 1.5.0.

  • C++ (falcon::ImageMaps): create(level, rgba), create(level, rgba, w, h, columns, rows, fit), createFromPng, place(level, topLeft, WallFacing, grid, glowing), update, isImageMap, remove, lastError; Player::giveMap(id)
  • C# (ImageMaps): Create, CreateFromPng, Place, Update, IsImageMap, Remove, LastError; Player.GiveMap
  • Java (ImageMaps): create, createFromPng, place, update, isImageMap, remove, lastError; Player.giveMap
  • C ABI: the map* functions (mapDeleteImage last) and playerGiveMap appended to FalconServerApi; mapPlaceImageGrid takes the id count and the server refuses any count other than columns × rows
  • mapDeleteImage erases an image map from memory and from the world save, and takes it out of loaded frames and online inventories; the docs cover id reuse and leftover copies
  • Fit modes: contain, cover, stretch; 0 columns or rows lets the image pick the grid size; place checks every slot before changing anything
  • Docs: docs/image-maps.md

The scripting layer is untouched: it only exposes Mojang's official Script API.

auto grid = falcon::ImageMaps::createFromPng(level, png, 4, 0, falcon::ImageFit::Contain);
falcon::ImageMaps::place(level, {10, 72, -4}, falcon::WallFacing::South, grid);
falcon::ImageMaps::update(level, grid.ids[0], 56, 56, 16, 16, pixels);

Test plan

  • .NET builds without warnings, C++ headers pass a syntax check
  • Java compiled with JDK 25 against the generated bindings
  • Server side tested in the Falcon PR

Comment thread docs/image-maps.md Resolved
@NaySurGithub
NaySurGithub merged commit f7db570 into main Nov 8, 2026
7 of 10 checks passed
@NaySurGithub
NaySurGithub deleted the feat/image-maps branch November 8, 2026 16:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant