Common Questions - jpenilla/squaremap GitHub Wiki

Here are a list of common questions we've been asked, and the answers we give.

How do I disable/enable worlds?

The config.yml is setup with per-world settings, just like Bukkit, Spigot, and Paper's configs are. In the world-settings you will add in any world specific settings you'd like to override from default.

For example, to disable the nether and end worlds you can do this:

world-settings:
  default:
    map:
      enabled: true
  minecraft:the_nether:
    map:
      enabled: false
  minecraft:the_end:
    map:
      enabled: false

This will enable all worlds by default, then explicitly disable the nether and end worlds. This is for if you have many worlds and want most of them enabled.

Another option would be:

world-settings:
  default:
    map:
      enabled: false
  minecraft:overworld:
    map:
      enabled: true

This simply disables all worlds by default, then explicitly enables only the main world. Sometimes this is the easier choice if you have many worlds but only want a few enabled.

How do I change the name of the world in the sidebar?

Same thing as How do I disable/enable worlds, use the per-world settings to override the display-name of the worlds.

world-settings:
  default:
    map:
      display-name: {world}
  minecraft:overworld:
    map:
      display-name: Overworld
  minecraft:the_nether:
    map:
      display-name: Nether
  minecraft:the_end:
    map:
      display-name: The End

Here, the {world} is a variable that gets replaced with the world's real name. For a lot of people, this is undesirable because of the capitalization and underscores. So just override each world with your own display name.

How do I disable/change the map link's embed data?

The embed data is just open graph meta tags in the main html document. You can edit these (or delete them) to your liking.

❗ Important ❗
To prevent the plugin from overwriting any changes you make to the html/css/js files you must disable settings.web-directory.auto-update

Here is the default open graph meta tags to look for in index.html:

    <meta name="description" content="Blazing fast live mapping solution for Minecraft servers">
    <meta property="og:url" content="https://github.com/jpenilla/squaremap">
    <meta property="og:type" content="website">
    <meta property="og:title" content="squaremap">
    <meta property="og:description" content="Blazing fast live mapping solution for Minecraft servers">
    <meta name="twitter:card" content="summary_large_image">
    <meta property="twitter:domain" content="github.com/jpenilla/squaremap">
    <meta property="twitter:url" content="https://github.com/jpenilla/squaremap">
    <meta name="twitter:title" content="squaremap">
    <meta name="twitter:description" content="Blazing fast live mapping solution for Minecraft servers">

How do I edit the page's title in the browser tab?

This is easily editable in the locale files.

ui:
  page-title: squaremap - {world}

The {world} variable here is from the world's display-name in config.yml.