https://github.com/faewulf/squaremap_banner

A fabric mod that is an extension for the SquareMap mod for Minecraft Fabric. It adds additional functionality related to banners within the game. Inspired by squaremap-banners plugins
https://github.com/faewulf/squaremap_banner

fabric-mod fabricmc minecraft minecraft-mod server-side squaremap-addon

Last synced: 16 days ago
JSON representation

A fabric mod that is an extension for the SquareMap mod for Minecraft Fabric. It adds additional functionality related to banners within the game. Inspired by squaremap-banners plugins

• Host: GitHub
• URL: https://github.com/faewulf/squaremap_banner
• Owner: FaeWulf
• License: cc0-1.0
• Created: 2024-05-22T16:58:20.000Z (6 months ago)
• Default Branch: master
• Last Pushed: 2024-05-22T17:18:06.000Z (6 months ago)
• Last Synced: 2024-05-22T18:34:40.419Z (6 months ago)
• Topics: fabric-mod, fabricmc, minecraft, minecraft-mod, server-side, squaremap-addon
• Language: Java
• Homepage:
• Size: 311 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SquareMap Banner Mod



  



A fabric mod that is an extension for the [SquareMap](https://github.com/jpenilla/squaremap) mod for Minecraft Fabric.

It adds

additional functionality related to banners within the game. Inspired

by [squaremap-banners plugins](https://github.com/jpenilla/squaremap-addons/tree/master/addons/banners)

## ✨Features

- **Banner marker**: Sneaking right-click with a named banner while holding a filled map will add that banner to the

  world map.

- **Banner Removal**: Sneaking left-click with a named banner while holding a filled map, or breaking the banner, will

  remove it from the world map.

- **Area Notification**: Displays a message when entering an area marked by a banner.



  



## ⚙️Configuration

The mod provides a JSON configuration file with the following options:

- `radius`: Specifies the size of the area declared by the banner.

- `announce_when_near_banner`: Enable/disable the message when entering the banner's area.

- `blacklist`: Contains a list of words to prevent from being registered to the world map.

## ⚠️Mod dependents

- Squaremap mod itself

- Fabric API

## 🪧Permissions

- **squaremap.banner.use**: Permission required for players to use the features provided by the mod.

- If non permission manager mod installed, then only players with permission level 1 and above can use the mod.

## 👍Support and Feedback

If you encounter any issues or have suggestions for improvement, please feel free to submit an issue on the GitHub

repository.