Skip to content

Custom localization for each player #537

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 26, 2021
Merged

Custom localization for each player #537

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
efca0b5
Added method to specify a custom locale for the proxy to use for each…
davidmayr Jul 9, 2021
d5cf598
Fixed checkstyle problems
davidmayr Jul 9, 2021
0c1c2da
Fixed checkstyle problems in impl
davidmayr Jul 9, 2021
ea489c1
Changed name to effectiveLocale, corrected javadocs
davidmayr Jul 25, 2021
178f40a
Simplified getEffectiveLocale, javadoc updates
davidmayr Jul 25, 2021
089a936
Used the javadoc suggested by astei
davidmayr Jul 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions api/src/main/java/com/velocitypowered/api/proxy/Player.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
import com.velocitypowered.api.util.GameProfile;
import com.velocitypowered.api.util.ModInfo;
import java.util.List;
import java.util.Locale;
import java.util.Optional;
import java.util.UUID;
import java.util.function.UnaryOperator;
Expand All @@ -45,6 +46,22 @@ public interface Player extends CommandSource, Identified, InboundConnection,
*/
String getUsername();

/**
* Returns the locale the proxy will use to send messages translated via the Adventure global translator.
* By default, the value of {@link PlayerSettings#getLocale()} is used.
*
* <p>This can be {@code null} when the client has not yet connected to any server.</p>
*
* @return the locale.
*/
@Nullable Locale getEffectiveLocale();

/**
* Change the locale the proxy will be translating its messages to.
*
* @param locale the locale to translate to
*/
void setEffectiveLocale(Locale locale);

/**
* Returns the player's UUID.
Expand Down
20 changes: 15 additions & 5 deletions proxy/src/main/java/com/velocitypowered/proxy/connection/client/ConnectedPlayer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@
import com.velocitypowered.api.util.GameProfile;
import com.velocitypowered.api.util.ModInfo;
import com.velocitypowered.proxy.VelocityServer;
import com.velocitypowered.proxy.config.VelocityConfiguration;
import com.velocitypowered.proxy.connection.MinecraftConnection;
import com.velocitypowered.proxy.connection.MinecraftConnectionAssociation;
import com.velocitypowered.proxy.connection.backend.VelocityServerConnection;
Expand Down Expand Up @@ -79,7 +78,6 @@
import java.util.Collections;
import java.util.List;
import java.util.Locale;
import java.util.Objects;
import java.util.Optional;
import java.util.Queue;
import java.util.UUID;
Expand All @@ -97,8 +95,6 @@
import net.kyori.adventure.text.serializer.gson.GsonComponentSerializer;
import net.kyori.adventure.text.serializer.legacy.LegacyComponentSerializer;
import net.kyori.adventure.text.serializer.plain.PlainComponentSerializer;
import net.kyori.adventure.title.Title;
import net.kyori.adventure.title.Title.Times;
import net.kyori.adventure.translation.GlobalTranslator;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
Expand Down Expand Up @@ -149,6 +145,7 @@ public class ConnectedPlayer implements MinecraftConnectionAssociation, Player {
.withStatic(PermissionChecker.POINTER, getPermissionChecker())
.build();
private @Nullable String clientBrand;
private @Nullable Locale effectiveLocale;

ConnectedPlayer(VelocityServer server, GameProfile profile, MinecraftConnection connection,
@Nullable InetSocketAddress virtualHost, boolean onlineMode) {
Expand Down Expand Up @@ -178,6 +175,19 @@ public String getUsername() {
return profile.getName();
}

@Override
public Locale getEffectiveLocale() {
if (effectiveLocale == null && settings != null) {
return settings.getLocale();
}
return effectiveLocale;
}

@Override
public void setEffectiveLocale(Locale locale) {
effectiveLocale = locale;
}

@Override
public UUID getUniqueId() {
return profile.getId();
Expand Down Expand Up @@ -276,7 +286,7 @@ public ProtocolVersion getProtocolVersion() {
*/
public Component translateMessage(Component message) {
Locale locale = ClosestLocaleMatcher.INSTANCE
.lookupClosest(this.settings == null ? Locale.getDefault() : this.settings.getLocale());
.lookupClosest(getEffectiveLocale() == null ? Locale.getDefault() : getEffectiveLocale());
return GlobalTranslator.render(message, locale);
}

Expand Down