Added the ability to change the text: Click to Unlock. As well as level and cost. #3977

svdermant · 2023-09-20T02:05:08Z

Description

Because there was no possibility to translate a specific text. I installed IDE Eclipse and imported the repo and made a Maven project from it.

Proposed changes

In the file SurvivalSlimefunGuide.java I changed certain things in line 292.
I also added 3 values to Messages.yml

Related Issues (if applicable)

no Issues was found

Checklist

I have fully tested the proposed changes and promise that they will not break everything into chaos.
I have also tested the proposed changes in combination with various popular addons and can confirm my changes do not break them.
I have made sure that the proposed changes do not break compatibility across the supported Minecraft versions (1.16.* - 1.20.*).
I followed the existing code standards and didn't mess up the formatting.

…lock - and Levels also Cost Code Changes a little bit with low knowhow it should be worked

Few Translations variables for Slimefun guide.click-unlock guide.cost guide.level

github-actions · 2023-09-20T02:05:23Z

Pro Tip!
You can help us label your Pull Requests by using the following branch naming convention next time you create a pull request. ❤️

Branch naming convention	Label
`feature/**`	🎈 Feature
`fix/**`	✨ Fix
`chore/**`	🧹 Chores
`api/**`	🔧 API
`performance/**`	💡 Performance Optimization
`compatibility/**`	🤝 Compatibility

If your changes do not fall into any of these categories, don't worry. You can just ignore this message in that case! 👀

messages.yml

...main/java/io/github/thebusybiscuit/slimefun4/implementation/guide/SurvivalSlimefunGuide.java

ybw0014 · 2023-09-20T03:07:26Z

...main/java/io/github/thebusybiscuit/slimefun4/implementation/guide/SurvivalSlimefunGuide.java

@@ -289,7 +289,7 @@ private void displaySlimefunItem(ChestMenu menu, ItemGroup itemGroup, Player p,
            menu.addItem(index, new CustomItemStack(ChestMenuUtils.getNoPermissionItem(), sfitem.getItemName(), message.toArray(new String[0])));
            menu.addMenuClickHandler(index, ChestMenuUtils.getEmptyClickHandler());
        } else if (isSurvivalMode() && research != null && !profile.hasUnlocked(research)) {
-            menu.addItem(index, new CustomItemStack(ChestMenuUtils.getNotResearchedItem(), ChatColor.WHITE + ItemUtils.getItemName(sfitem.getItem()), "&4&l" + Slimefun.getLocalization().getMessage(p, "guide.locked"), "", "&a> Click to unlock", "", "&7Cost: &b" + research.getCost() + " Level(s)"));
+            menu.addItem(index, new CustomItemStack(ChestMenuUtils.getNotResearchedItem(), ChatColor.WHITE + ItemUtils.getItemName(sfitem.getItem()), "&4&l" + Slimefun.getLocalization().getMessage(p, "guide.locked"), "", "&a>" + Slimefun.getLocalization().getMessage(p, "guide.click-unlock"), "", "&7" + Slimefun.getLocalization().getMessage(p, "guide.Cost") + research.getCost() + Slimefun.getLocalization().getMessage(p, "guide.Level")));


the message key should be lowercase and use hyphens (-) to connect words.
And I don't think string concatenation is good here, better use placeholder.

No i should not be Lowercase it works with this setup! :)
After all, I tested everything before the request!

The key should be lowercase, or it will break the naming convention.
Also, consider using a placeholder instead of concatenating 3 parts for the cost line.

Hmmm did you mean "getMessage" or "getMessage(p, "guide.Cost")"
Should it be named getMessage(p, "guide.cost") ?

The red line shows the original.
Below is my slightly changed line

No placeholder was used there either. Do I know any placeholders that are marked with %? correct?

Yes it should be "guide.cost" the whole key should be lowercase.

As for the formatting and placeholders look at the javadocs or some examples for the String#format method to find how it works.

I don't think I need to read about it because the original code, i.e. the red line, doesn't use a placeholder either. It's actually a function query called research.getCost() its not a placeholder so please explain to me exactly what you mean by placeholders?

JustAHuman-xD · 2023-09-20T12:39:45Z

You can find the right messages.yml in src->main->resources->language->en

adding 3 new message keys for the code in SurvivalSlimefunGuide.java

… myself as new Author

svdermant · 2023-09-20T12:53:28Z

i hope thats now my taken changes are correct. i'm new in this scene and i do my best to understand the code structure.

variananora · 2023-09-20T13:01:02Z

src/main/resources/languages/en/messages.yml

@@ -44,6 +44,9 @@ placeholderapi:

 guide:
  locked: 'LOCKED'
+  click-unlock: You Must Unlock This!
+  cost: 'Cost: '
+  level: ' Level(s)'


I personally dislike the space here, I think the language file should not include this space and move the space to the code. Not sure how other feels about this one. Any suggestion on this?

without the spaces the languagewords is combined so in the lore stands without them cost1Level(s)
So i add the Spaces for it.

i dont know how to add spaces in the code by "&7" + Slimefun.getLocalization().getMessage(p, "guide.cost") + research.getCost() + Slimefun.getLocalization().getMessage(p, "guide.level"))) in line 292 at SurvivalSlimefunGuide.java

so i add spaces in the message key to solve this. Even if it's probably wrong.
I'm still pretty new.

on my local machine i removed for testing the spaces in the message keywords... the result is watching the picture.

To solve this i add spaces ...

Or for better understand how can i add spaces in the code add line 293 at SurvivalSlimefunGuide.java

...main/java/io/github/thebusybiscuit/slimefun4/implementation/guide/SurvivalSlimefunGuide.java

SchnTgaiSpock · 2023-09-20T17:02:07Z

The "Level(s)" message should be "%level% Level(s)" and then format it like the other messages

ybw0014 · 2023-09-20T17:39:17Z

...main/java/io/github/thebusybiscuit/slimefun4/implementation/guide/SurvivalSlimefunGuide.java

@@ -289,7 +290,7 @@ private void displaySlimefunItem(ChestMenu menu, ItemGroup itemGroup, Player p,
            menu.addItem(index, new CustomItemStack(ChestMenuUtils.getNoPermissionItem(), sfitem.getItemName(), message.toArray(new String[0])));
            menu.addMenuClickHandler(index, ChestMenuUtils.getEmptyClickHandler());
        } else if (isSurvivalMode() && research != null && !profile.hasUnlocked(research)) {
-            menu.addItem(index, new CustomItemStack(ChestMenuUtils.getNotResearchedItem(), ChatColor.WHITE + ItemUtils.getItemName(sfitem.getItem()), "&4&l" + Slimefun.getLocalization().getMessage(p, "guide.locked"), "", "&a> Click to unlock", "", "&7Cost: &b" + research.getCost() + " Level(s)"));
+            menu.addItem(index, new CustomItemStack(ChestMenuUtils.getNotResearchedItem(), ChatColor.WHITE + ItemUtils.getItemName(sfitem.getItem()), "&4&l" + Slimefun.getLocalization().getMessage(p, "guide.locked"), "", "&a>" + Slimefun.getLocalization().getMessage(p, "guide.click-unlock"), "", "&7" + Slimefun.getLocalization().getMessage(p, "guide.cost") + research.getCost() + Slimefun.getLocalization().getMessage(p, "guide.level")));


add space before guide.click-unlock would better

that is what i whant to know how can i add spaces in the code?

That workes with the space in the " " string.. but how can i add spaces in functions with the given code:
menu.addItem(index, new CustomItemStack(ChestMenuUtils.getNotResearchedItem(), ChatColor.WHITE + ItemUtils.getItemName(sfitem.getItem()), "&4&l" + Slimefun.getLocalization().getMessage(p, "guide.locked"), "", "&a> " + Slimefun.getLocalization().getMessage(p, "guide.click-unlock"), "", "&7" + Slimefun.getLocalization().getMessage(p, "guide.cost") + research.getCost() + Slimefun.getLocalization().getMessage(p, "guide.level")));

It Looks ingame so.:

Also the hint from SchnTgaiSpock with the %level% dont work..

ybw0014 · 2023-09-20T17:39:19Z

src/main/resources/languages/en/messages.yml

@@ -44,6 +44,9 @@ placeholderapi:

 guide:
  locked: 'LOCKED'
+  click-unlock: You Must Unlock This!


Better keep the original Click to unlock

svdermant · 2023-09-20T18:17:26Z

The "Level(s)" message should be "%level% Level(s)" and then format it like the other messages

This format does not work ... i get this ingame...

…sage Keys - Thanks to Idra Adding Spaces to the code for Message Keys - Thanks to Idra

…k to Unlock Remove Spaces and add the Orginal Text for Click to Unlock

iTwins

These suggestions fix everything (tested them already).

iTwins · 2023-09-21T01:37:57Z

src/main/resources/languages/en/messages.yml

+  click-unlock: Click to unlock
+  cost: 'Cost:'
+  level: 'Level(s)'


Suggested change

click-unlock: Click to unlock

cost: 'Cost:'

level: 'Level(s)'

click-unlock:

- '&4&lLOCKED'

- ''

- '&a> Click to unlock'

- ''

- '&7Cost: &b%cost%'

unlock-currency:

levels: 'Level(s)'

iTwins · 2023-09-21T01:58:40Z

...main/java/io/github/thebusybiscuit/slimefun4/implementation/guide/SurvivalSlimefunGuide.java

@@ -289,7 +290,7 @@ private void displaySlimefunItem(ChestMenu menu, ItemGroup itemGroup, Player p,
            menu.addItem(index, new CustomItemStack(ChestMenuUtils.getNoPermissionItem(), sfitem.getItemName(), message.toArray(new String[0])));
            menu.addMenuClickHandler(index, ChestMenuUtils.getEmptyClickHandler());
        } else if (isSurvivalMode() && research != null && !profile.hasUnlocked(research)) {
-            menu.addItem(index, new CustomItemStack(ChestMenuUtils.getNotResearchedItem(), ChatColor.WHITE + ItemUtils.getItemName(sfitem.getItem()), "&4&l" + Slimefun.getLocalization().getMessage(p, "guide.locked"), "", "&a> Click to unlock", "", "&7Cost: &b" + research.getCost() + " Level(s)"));
+            menu.addItem(index, new CustomItemStack(ChestMenuUtils.getNotResearchedItem(), ChatColor.WHITE + ItemUtils.getItemName(sfitem.getItem()), "&4&l" + Slimefun.getLocalization().getMessage(p, "guide.locked"), "", "&a> " + Slimefun.getLocalization().getMessage(p, "guide.click-unlock"), "", "&7" + Slimefun.getLocalization().getMessage(p, "guide.cost") + " " + research.getCost() + " " + Slimefun.getLocalization().getMessage(p, "guide.level")));


Suggested change

menu.addItem(index, new CustomItemStack(ChestMenuUtils.getNotResearchedItem(), ChatColor.WHITE + ItemUtils.getItemName(sfitem.getItem()), "&4&l" + Slimefun.getLocalization().getMessage(p, "guide.locked"), "", "&a> " + Slimefun.getLocalization().getMessage(p, "guide.click-unlock"), "", "&7" + Slimefun.getLocalization().getMessage(p, "guide.cost") + " " + research.getCost() + " " + Slimefun.getLocalization().getMessage(p, "guide.level")));

menu.addItem(index, new CustomItemStack(ChestMenuUtils.getNotResearchedItem().getType(), ChatColor.WHITE + ItemUtils.getItemName(sfitem.getItem()), Slimefun.getLocalization().getMessages(p, "guide.click-unlock", str -> str.replace("%cost%", research.getCost() + Slimefun.getLocalization().getMessage(p, "guide.unlock-currency.levels")))));

what if we can use other ways to unlock in the future? i mean this PR: #3942

This would also create merge conflicts with that pr, so we could also make it translatable in that pr and close this one.

That’s out of scope tho. Creating merge conflicts isn’t the end of the world. And for bigger PRs like that it would be halted by extensive testing anyways

Then I guess we don't have to worry about other unlock methods in this pr and just have the other pr handle the changes to that.

I'm wondering if the line "Cost: (condition)" should be separated.

I would agree with that.

Putting these under a single key is more annoying to untangle later.

True. I edited the suggestion. Is this better?

not too sure how crowdin works but wouldn't those two empty lines show up as empty strings to translate? wouldnt break anything; just a little confusing

github-actions · 2023-09-30T10:53:53Z

Slimefun preview build

A Slimefun preview build is available for testing!
Commit: 837590ef

https://preview-builds.walshy.dev/download/Slimefun/3977/837590ef

Note: This is not a supported build and is only here for the purposes of testing.
Do not run this on a live server and do not report bugs anywhere but this PR!

Boomer-1 · 2023-11-23T01:51:07Z

i was going to test this but i couldn't ultimately see what was happening, and it seems to be a change of language, so someone who can read multiple languages would be better off testing

J3fftw1 · 2023-12-31T09:45:06Z

Marking this as stale

J3fftw1 · 2024-02-25T17:11:15Z

Closing this as stale

svdermant added 2 commits September 20, 2023 03:44

Update SurvivalSlimefunGuide.java - Adding Translation for Open to Un…

85641f1

…lock - and Levels also Cost Code Changes a little bit with low knowhow it should be worked

Adding Translation for Open to Unlock etc

b165697

Few Translations variables for Slimefun guide.click-unlock guide.cost guide.level

svdermant requested a review from a team as a code owner September 20, 2023 02:05

svdermant changed the title ~~Added the ability to change the text: Click to Unlock. As well as level and cost.~~ fix/** Added the ability to change the text: Click to Unlock. As well as level and cost. Sep 20, 2023

svdermant changed the title ~~fix/** Added the ability to change the text: Click to Unlock. As well as level and cost.~~ Added the ability to change the text: Click to Unlock. As well as level and cost. Sep 20, 2023

ybw0014 suggested changes Sep 20, 2023

View reviewed changes

svdermant requested a review from ybw0014 September 20, 2023 03:53

Delete messages.yml - because it was not the orginal

758ffd3

svdermant added 3 commits September 20, 2023 14:41

Update messages.yml

55df137

adding 3 new message keys for the code in SurvivalSlimefunGuide.java

Update messages.yml - wrong main language key string

d9ecede

Update SurvivalSlimefunGuide.java - Change back the Copyright and add…

a27e1b7

… myself as new Author

variananora added the 🎈 Feature This Pull Request adds a new feature. label Sep 20, 2023

variananora suggested changes Sep 20, 2023

View reviewed changes

Update SurvivalSlimefunGuide.java - message keys now lowercase

a6f7737

ybw0014 suggested changes Sep 20, 2023

View reviewed changes

J3fftw1 added the 🎯 Needs testing This Issue needs to be tested by our team to see if it can be reproduced. label Sep 20, 2023

svdermant added 2 commits September 20, 2023 21:52

Update SurvivalSlimefunGuide.java - Adding Spaces to the code for Mes…

a1de6b5

…sage Keys - Thanks to Idra Adding Spaces to the code for Message Keys - Thanks to Idra

Update messages.yml - Remove Spaces and add the Orginal Text for Clic…

920e094

…k to Unlock Remove Spaces and add the Orginal Text for Click to Unlock

iTwins reviewed Sep 21, 2023

View reviewed changes

J3fftw1 added the Stale Marks a PR as stale. label Dec 31, 2023

J3fftw1 closed this Feb 25, 2024

-  click-unlock: Click to unlock
-  cost: 'Cost:'
-  level: 'Level(s)'
+  click-unlock:
+  - '&4&lLOCKED'
+  - ''
+  - '&a> Click to unlock'
+  - ''
+  - '&7Cost: &b%cost%'
+  unlock-currency:
+    levels: 'Level(s)'

Added the ability to change the text: Click to Unlock. As well as level and cost. #3977

Added the ability to change the text: Click to Unlock. As well as level and cost. #3977

Conversation

svdermant commented Sep 20, 2023 • edited Loading

Description

Proposed changes

Related Issues (if applicable)

Checklist

github-actions bot commented Sep 20, 2023

Choose a reason for hiding this comment

svdermant Sep 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

svdermant Sep 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JustAHuman-xD commented Sep 20, 2023 • edited Loading

svdermant commented Sep 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

svdermant Sep 20, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

SchnTgaiSpock commented Sep 20, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

svdermant commented Sep 20, 2023

iTwins left a comment

Choose a reason for hiding this comment

iTwins Sep 21, 2023 • edited Loading

Choose a reason for hiding this comment

iTwins Sep 21, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Sep 30, 2023

Slimefun preview build

Boomer-1 commented Nov 23, 2023

J3fftw1 commented Dec 31, 2023

J3fftw1 commented Feb 25, 2024

svdermant commented Sep 20, 2023 •

edited

Loading

svdermant Sep 20, 2023 •

edited

Loading

svdermant Sep 20, 2023 •

edited

Loading

JustAHuman-xD commented Sep 20, 2023 •

edited

Loading

svdermant Sep 20, 2023 •

edited

Loading

iTwins Sep 21, 2023 •

edited

Loading

iTwins Sep 21, 2023 •

edited

Loading