arcade-minimap/README.md

3.3 KiB

Minimaps Build status badge

Use this extension

This extension allows you to create "minimaps". Minimaps are smaller representations of the tilemap and optionally any sprites you would like to include.

Basic usage

Here's the most basic way to use the minimap: arcade-screenshot (3) Screen Shot 2020-08-13 at 10 45 19 AM

Including sprites

To include sprites on the minimap, use the "draw (mySprite) on (myMinimap)" block: arcade-screenshot (4) Screen Shot 2020-08-13 at 10 47 10 AM

Updating the minimap

To constantly update the minimap based on sprite movement and tilemap changes, use "on game update": arcade-screenshot (5) download

Example projects

See the forums: https://forum.makecode.com/t/minimap-extension-beta/1709

Performance considerations

If you're updating the minimap with an "on game update" or "forever" block, be aware that this can slow your game down a lot if:

  • many sprites are being draw to the minimap
  • the tilemap is very large
  • the updates are happening faster than every 500ms

If you notice your game running slow, try reducing the speed at which you update the minimap.

Add this extension

This repository can be added as an extension in MakeCode.

  • open https://arcade.makecode.com/
  • click on New Project
  • click on Extensions under the gearwheel menu
  • search for the URL of this repository and import

Edit this extension

To edit this repository in MakeCode.

Supported targets

  • for PXT/arcade
  • for PXT/arcade (The metadata above is needed for package search.)

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.