2.2 to 2.3 Migration Guide

Part1: Player Data

Situation 1: I am using YAML

step1: stop the server and install CustomNameplates step2: run /nameplates data export-legacy YAML step3: run /nameplates data import exported-xxxx-xx-xx-xx-xx.json.json.gz

Situation 1: I am using MySQL/MariaDB

step1: stop the server and install CustomNameplates step2: configure /CustomNameplates/database.yml and reload the plugin step3: run /nameplates data export-legacy MySQL/MariaDB step4: stop the server and delete "nameplates_data" table from your database step5: start the server and run /nameplates data import exported-xxxx-xx-xx-xx-xx.json.json.gz

Common Question: Q: Will my player's nameplates get lost if I can't migrate the data? A: No, your player's nameplate and bubble ownerships are stored by permissions.

Part2: Configurations

I would rather let myself be more painful coding than letting my users painful. So almost 99% configurations are automatically converted when you restart the server. But it's better to take a look at these files before you put your server back to production envirmoments.

① custom-placeholders.yml vanilla-hud

Vanilla hud no longer supports placeholders in images section for better performance. If you were using images from other plugins, please register them in customnameplates instead

② custom-placeholders.yml descent-unicode

If you received warning "Duplicated key 'xxx' found during migration. Please manually fix that." This is caused by there exists the same key when merging two sections, here the example of why that happens.

③ image-width.yml is now in font-width-data.yml

Font's width data has been supported since 2.3 so old configs no longer work in new version. You can safely delete image-width.yml when you successfully move the characters into the new file. The reason why I don't automatically convert this for you is because the image-width.yml contains too much data. And they are replaced by the new "template-loading-sequence" option.

④ Now you can create at most 1 actionbar config in actionbar.yml. Plugin would give warnings if you have many.

⑤No more <font:unicode_ascent_x> </font>

To reduce the size of the resource pack, the font has been merged so those unicode_ascent_x fonts are deprecated.

custom-placeholders.yml

Before:

static-text:  
  income_actionbar:
    position: middle
    text: "<font:nameplates:unicode_ascent_8>%nameplates_actionbar%</font>"
    value: 180

After:

static-text:
  income_actionbar:
    position: middle
    text: "%nameplates_actionbar%"
    value: 180

contents/bubbles/chat.yml

Before:

text-format:
  start: '<black><font:nameplates:unicode_ascent_8>'
  end: '</font></black>'

After:

text-format:
  start: '<black>'
  end: '</black>'

Now the migration has finished. What you need to do is deleting README.txt from plugin folder and restart your server!

Last updated