Skip to content

Common Questions

Jump to bottom Edit New page
granny edited this page Jun 22, 2024 · 4 revisions

How can I customize the discord embed?

  1. Open config.yml, and set web-directory.read-only to true - this is so your changes will not get undone.
  2. Go to the web directory, and open the file that says index.html with a file editor like notepad++ or another editor that won't auto-format things on you. This is what that file looks like:

index.html

 
<!DOCTYPE html>
<html lang="en">
  <head>
    ...

    <meta name="description" content="Blazing fast live mapping solution for Paper and friends"/>
    <meta name="keywords" content="minecraft, map, dynamic, pl3x, pl3xmap"/>

    <!-- facebook meta tags -->
    <meta property="og:url" content="https://github.com/granny/Pl3xMap/"/>
    <meta property="og:type" content="website"/>
    <meta property="og:title" content="Pl3xMap"/>
    <meta property="og:description" content="Blazing fast live mapping solution for Paper and friends"/>
    <meta property="og:image" content="https://raw.githubusercontent.com/granny/Pl3xMap/v3/webmap/public/images/og.png"/>

    <!-- twitter meta tags -->
    <meta name="twitter:card" content="summary_large_image"/>
    <meta property="twitter:domain" content="github.com/granny/Pl3xMap"/>
    <meta property="twitter:url" content="https://github.com/granny/Pl3xMap"/>
    <meta name="twitter:title" content="Pl3xMap"/>
    <meta name="twitter:description" content="Blazing fast live mapping solution for Paper and friends"/>
    <meta name="twitter:image" content="https://raw.githubusercontent.com/granny/Pl3xMap/v3/webmap/public/images/og.png"/>

    <!-- browser support -->
    <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
    <meta name="viewport" content="width=device-width,initial-scale=1.0,user-scalable=no"/>
    <meta name="apple-mobile-web-app-capable" content="yes"/>
    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"/>
    <meta name="theme-color" content="#222222"/>

    ...
  </body>
</html>
  </body>
</html>
  1. Edit what you want to customize - this won't be most of the file. Here is an example:

Edited index.html

 
<!DOCTYPE html>
<html lang="en">
  <head>
    ...

++  <meta name="description" content="Super cool map for my Super Cool Server"/>
    <meta name="keywords" content="minecraft, map, dynamic, pl3x, pl3xmap"/>

    <!-- facebook meta tags -->
++  <meta property="og:url" content="map.supercoolserversite.com"/>
    <meta property="og:type" content="website"/>
++  <meta property="og:title" content="Map of Super Cool Server"/>
++  <meta property="og:description" content="Super cool map for my Super Cool Server"/>
++  <meta property="og:image" content="https://somelogo.with/a/working/link.png"/>

    <!-- twitter meta tags -->
    <meta name="twitter:card" content="summary_large_image"/>
++  <meta property="twitter:domain" content="map.supercoolserversite.com"/>
++  <meta property="twitter:url" content="https://map.supercoolserversite.com"/>
++  <meta name="twitter:title" content="Map of Super Cool Server"/>
++  <meta name="twitter:description" content="Super cool map for my Super Cool Server"/>
++  <meta name="twitter:image" content="https://somelogo.with/a/working/link.png"/>

    <!-- browser support -->
    <meta http-equiv="X-UA-Compatible" content="IE=edge"/>
    <meta name="viewport" content="width=device-width,initial-scale=1.0,user-scalable=no"/>
    <meta name="apple-mobile-web-app-capable" content="yes"/>
    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent"/>
++  <meta name="theme-color" content="#001F52"/>

    ...
  </body>
</html>
  1. Reload the plugin

Note, due to discord cache, it may not show the new embed correctly right away. If you are not seeing changes, try asking someone else to screenshot what it looks like

How can I customize the icons used for the renderers?

  1. In your config.yml navigate to renderers - this is where you will set them
  2. Put the name of the image you want to use (if your image is named cool_world.png - put cool_world)
  3. Go to the web/images/icon directory and place the images you set in the config, in that folder.
  4. Reload the plugin

How do I stop a specific world from showing up?

First, you need to understand how the config works. When you open your config.yml file you should see a world-settings section with a default key. All the options under this section are what apply the "defaults" to all the worlds in your server.

Below is a very stripped down version of the config (The three dots symbolize other options that may exist in your config, but were excluded for educational purposes):

settings:
  ...
world-settings:
  default:
    enabled: true
    ...
  world:
    ...
  world_nether:
    ...
  world_the_end:
    enabled: false

In this example, all the worlds (in this case, world and world_nether) will be visible except for world_the_end.

You could also do it the opposite way to hide all your world except for one or two that you want visible. This would look something like this:

settings:
  ...
world-settings:
  default:
    enabled: false
    ...
  world:
    enabled: true
  world_nether:
    ...
  world_the_end:
    enabled: true

In this example, all the worlds will not be visible except for world and world_the_end. Any future worlds that get added will not be visible until I come back to the config to override the default for those specific worlds.

Join the discord for help! https://granny.dev/discord

Clone this wiki locally