Fix typos and improve language in the config

This commit is contained in:
Vankka 2024-11-14 22:45:36 +02:00
parent 1df466dc09
commit 3b0ee1dd5a
No known key found for this signature in database
GPG Key ID: 62E48025ED4E7EBB
12 changed files with 18 additions and 10 deletions

View File

@ -31,9 +31,9 @@ public class AvatarProviderConfig {
public boolean autoDecideAvatarUrl = true;
@Untranslated(Untranslated.Type.VALUE)
@Constants("auto-decide-avatar-url")
@Comment("The template for URLs of player avatars\n" +
"This will be used for official Java players only if %1 is set to true\n" +
"This will be used ALWAYS if %1 is set to false")
@Constants.Comment("auto-decide-avatar-url")
public String avatarUrlTemplate = "https://crafatar.com/avatars/%player_uuid_short%.png?size=128&overlay#%player_skin_texture_id%";
}

View File

@ -29,7 +29,7 @@ import java.util.Map;
@ConfigSerializable
public class DebugConfig {
@Comment("If debug messages should be logged into the config")
@Comment("If debug messages should be logged into the console")
public boolean logToConsole = false;
@Comment("Additional levels to log\nExample value: %1")

View File

@ -55,7 +55,9 @@ public class DiscordCommandConfig {
+ "- ansi: A colored ansi code block\n"
+ "- plain: Plain text\n"
+ "- code_block: Plain code block\n"
+ "- off: No command output")
+ "- off: No command output\n"
+ "\n"
+ "Please note that some commands may not be work with output forwarding")
public OutputMode outputMode = OutputMode.MARKDOWN;
@Comment("At least one condition has to match to allow execution")
@ -66,7 +68,7 @@ public class DiscordCommandConfig {
public boolean suggest = true;
@Comment("If suggestions should be filtered based on the \"%1\" option")
@Constants.Comment("filters")
@Constants.Comment("execution-conditions")
public boolean filterSuggestions = true;
}

View File

@ -128,6 +128,7 @@ public abstract class MainConfig implements Config {
}
@Order(1000)
@Comment("These options are for fine-tuning, only touch them if you know what you're doing")
public MemberCachingConfig memberCaching = new MemberCachingConfig();
@Order(5000)

View File

@ -25,7 +25,7 @@ import org.spongepowered.configurate.objectmapping.meta.Comment;
public class MessagesMainConfig {
@Comment("The language code for the default language, if left blank the system default will be used.\n"
+ "This should be in the ISO 639-1 format or ISO 639-1 (for example \"en\"), a underscore and a ISO 3166-1 country code to specify dialect (for example \"pt_BR\")")
+ "This should be in the ISO 639-1 format (for example \"en\"), or ISO 639-1, a underscore and a ISO 3166-1 country code to specify dialect (for example \"pt_BR\")")
public String defaultLanguage = "en";
@Comment("If there should be a messages file per language (based on the player's or user's language), otherwise using the default")

View File

@ -53,7 +53,7 @@ public class TimedUpdaterConfig {
private static final int MINIMUM_MINUTES = 10;
@Comment("The channel IDs.\n"
+ "The bot will need the \"View Channel\", \"Manage Channels\" and \"Connection\" permissions for the provided channels")
+ "The bot will need the \"View Channel\", \"Manage Channels\" and \"Connect\" permissions for the provided channels")
public List<Long> channelIds = new ArrayList<>();
@Comment("The format for the channel name(s), placeholders are supported.")

View File

@ -28,6 +28,7 @@ import com.discordsrv.common.config.main.generic.IMessageConfig;
import org.jetbrains.annotations.Nullable;
import org.spongepowered.configurate.objectmapping.ConfigSerializable;
import org.spongepowered.configurate.objectmapping.meta.Comment;
import org.spongepowered.configurate.objectmapping.meta.Setting;
@ConfigSerializable
public class JoinMessageConfig implements IMessageConfig {
@ -52,6 +53,7 @@ public class JoinMessageConfig implements IMessageConfig {
public Boolean enableSilentPermission = true;
@Comment("Ignore if the player leaves within the given amount of milliseconds. This will delay sending the join message")
@Setting("ignore-if-left-within-ms")
public Long ignoreIfLeftWithinMS = 250L;
@Override

View File

@ -26,6 +26,7 @@ import com.discordsrv.common.config.configurate.manager.abstraction.ConfigurateC
import com.discordsrv.common.config.main.generic.IMessageConfig;
import org.spongepowered.configurate.objectmapping.ConfigSerializable;
import org.spongepowered.configurate.objectmapping.meta.Comment;
import org.spongepowered.configurate.objectmapping.meta.Setting;
@ConfigSerializable
public class LeaveMessageConfig implements IMessageConfig {
@ -50,6 +51,7 @@ public class LeaveMessageConfig implements IMessageConfig {
public Boolean enableSilentPermission = true;
@Comment("Ignore if the player joined within the given amount of milliseconds")
@Setting("ignore-if-joined-within-ms")
public Long ignoreIfJoinedWithinMS = 250L;
@Override

View File

@ -33,7 +33,7 @@ public class MirroringConfig {
@Comment("Requires the \"Message Content Intent\"")
public Boolean enabled = true;
@Comment("Users, bots, roles and webhooks to ignore when mirroring")
@Comment("Users to not mirror")
public DiscordIgnoresConfig ignores = new DiscordIgnoresConfig();
@Comment("The format of the username of mirrored messages\n"

View File

@ -49,7 +49,7 @@ public class GameCommandExecutionConditionConfig {
@Comment("The commands and/or patterns that are allowed/blocked.\n" +
"The command needs to start with input, this will attempt to normalize command aliases where possible (for the main command)\n" +
"If the command start and ends with /, the input will be treated as a regular expression (regex) and it will pass if it matches the entire command")
"If the command starts and ends with /, the input will be treated as a regular expression (regex) and it will pass if it matches the entire command")
public List<String> commands = new ArrayList<>();
public static boolean isCommandMatch(String configCommand, String command, boolean suggestions, GameCommandExecutionHelper helper) {

View File

@ -31,10 +31,10 @@ public class LinkedAccountConfig {
@Comment("The linked account provider\n"
+ "\n"
+ " - auto: Uses \"minecraftauth\" if the %1 permits it and the server is in online mode or using ip forwarding, otherwise \"%4\"\n"
+ " - auto: Uses \"minecraftauth\" if the %1 permits it and the server is in online mode or using ip forwarding, otherwise \"%3\"\n"
+ " - minecraftauth: Uses %2 as the linked account provider (offline and (non-linked) bedrock players cannot link using this method)\n"
+ " - storage: Use the configured database for linked accounts")
@Constants.Comment({ConnectionConfig.FILE_NAME, "minecraftauth.me"})
@Constants.Comment({ConnectionConfig.FILE_NAME, "minecraftauth.me", "storage"})
public Provider provider = Provider.AUTO;
public enum Provider {

View File

@ -291,6 +291,7 @@ public class ReceivedDiscordMessageImpl implements ReceivedDiscordMessage {
.addPlaceholder("message", component)
.addContext(replyingTo.getMember(), replyingTo.getAuthor(), replyingTo)
.build()
// TODO: add contentRegexFilters to this
);
}