Compare commits

...

4 commits

Author SHA1 Message Date
axolotlmaid
531e64fda2 fix: profile configuration being overwritten 2024-09-14 21:58:51 +01:00
axolotlmaid
8843ee8a53 work in progress 2024-09-14 21:56:01 +01:00
axolotlmaid
81a4370297 Add profile loading on startup (#17) 2024-08-12 14:16:27 +01:00
axolotlmaid
5ef62d174c Fix error when deleting profile 2024-08-12 14:15:04 +01:00
11 changed files with 135 additions and 76 deletions

View file

@ -14,6 +14,10 @@ repositories {
includeGroup "maven.modrinth"
}
}
maven {
url "https://maven.enjarai.nl/releases"
}
}
dependencies {
@ -27,4 +31,5 @@ dependencies {
modImplementation "maven.modrinth:sodium-extra:mc1.21-0.5.7" // Sodium Extra
modImplementation "maven.modrinth:embeddium:1.0.2+mc1.21" // Embeddium
modImplementation "maven.modrinth:distanthorizons:2.1.2-a-1.21" // Distant Horizons
modImplementation "nl.enjarai:shared-resources-api:1.8.3" // Shared Resources
}

View file

@ -4,27 +4,11 @@ import com.axolotlmaid.optionsprofiles.profiles.Profiles;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
public class OptionsProfilesMod {
public static final String MOD_ID = "optionsprofiles";
public static final Logger LOGGER = LogManager.getLogger("Options Profiles");
public static void init() {
Path profilesDirectory = Paths.get("options-profiles");
public static final Profiles PROFILES_INSTANCE = new Profiles();
if (Files.notExists(profilesDirectory)) {
try {
Files.createDirectory(profilesDirectory);
} catch (IOException e) {
LOGGER.error("An error occurred when creating the 'options-profiles' directory.", e);
}
}
// Update / add configuration for existing profiles
Profiles.updateProfiles();
}
public static void init() {}
}

View file

@ -1,11 +1,10 @@
package com.axolotlmaid.optionsprofiles.gui;
import com.axolotlmaid.optionsprofiles.OptionsProfilesMod;
import com.axolotlmaid.optionsprofiles.profiles.ProfileConfiguration;
import com.axolotlmaid.optionsprofiles.profiles.Profiles;
import net.minecraft.ChatFormatting;
import net.minecraft.client.gui.components.Button;
import net.minecraft.client.gui.components.EditBox;
import net.minecraft.client.gui.components.StringWidget;
import net.minecraft.client.gui.components.Tooltip;
import net.minecraft.client.gui.components.*;
import net.minecraft.client.gui.layouts.HeaderAndFooterLayout;
import net.minecraft.client.gui.layouts.LayoutSettings;
import net.minecraft.client.gui.layouts.LinearLayout;
@ -13,10 +12,13 @@ import net.minecraft.client.gui.screens.Screen;
import net.minecraft.network.chat.CommonComponents;
import net.minecraft.network.chat.Component;
import java.nio.file.Files;
public class EditProfileScreen extends Screen {
private final ProfilesScreen profilesScreen;
private final HeaderAndFooterLayout layout = new HeaderAndFooterLayout(this, 24, 33);
private final ProfileConfiguration profileConfiguration;
private final Component profileName;
private EditBox profileNameEdit;
@ -24,6 +26,7 @@ public class EditProfileScreen extends Screen {
super(Component.literal(Component.translatable("gui.optionsprofiles.editing-profile-title").getString() + profileName.getString()));
this.profilesScreen = profilesScreen;
this.profileName = profileName;
this.profileConfiguration = ProfileConfiguration.get(profileName.getString());
}
protected void init() {
@ -45,11 +48,10 @@ public class EditProfileScreen extends Screen {
Button.builder(
Component.translatable("gui.optionsprofiles.overwrite-options"),
(button) -> {
Profiles.writeProfile(profileName.getString(), true);
OptionsProfilesMod.PROFILES_INSTANCE.writeProfile(profileName.getString(), true);
this.onClose();
})
.size(150, 20)
.pos(this.width / 2 - 75, 145)
.tooltip(Tooltip.create(Component.translatable("gui.optionsprofiles.overwrite-options.tooltip")))
.build(),
LayoutSettings::alignHorizontallyCenter
@ -58,24 +60,32 @@ public class EditProfileScreen extends Screen {
Button.builder(
Component.translatable("gui.optionsprofiles.rename-profile"),
(button) -> {
Profiles.renameProfile(profileName.getString(), this.profileNameEdit.getValue());
OptionsProfilesMod.PROFILES_INSTANCE.renameProfile(profileName.getString(), this.profileNameEdit.getValue());
this.minecraft.setScreen(new EditProfileScreen(profilesScreen, Component.literal(this.profileNameEdit.getValue())));
})
.size(150, 20)
.pos(this.width / 2 - 75, 166)
.build(),
LayoutSettings::alignHorizontallyCenter
);
linearLayoutButtons.addChild(
Button.builder(
Component.translatable("gui.optionsprofiles.options-toggle").append("..."),
(button) -> this.minecraft.setScreen(new OptionsToggleScreen(this, profileName)))
(button) -> this.minecraft.setScreen(new OptionsToggleScreen(this, profileName, profileConfiguration)))
.size(150, 20)
.pos(this.width / 2 - 75, 187)
.tooltip(Tooltip.create(Component.translatable("gui.optionsprofiles.options-toggle.tooltip")))
.build(),
LayoutSettings::alignHorizontallyCenter
);
linearLayoutButtons.addChild(
Checkbox.builder(
Component.literal("Load on startup"),
this.font
)
.selected(profileConfiguration.isLoadOnStartup())
.onValueChange((checkbox, value) -> profileConfiguration.setLoadOnStartup(value))
.build(),
(layoutSettings) -> layoutSettings.alignHorizontallyCenter().paddingTop(5)
);
this.layout.addToFooter(
Button.builder(
@ -89,7 +99,7 @@ public class EditProfileScreen extends Screen {
Component.translatable("gui.optionsprofiles.delete-profile")
.withStyle(ChatFormatting.RED),
(button) -> {
Profiles.deleteProfile(profileName.getString());
OptionsProfilesMod.PROFILES_INSTANCE.deleteProfile(profileName.getString());
this.onClose();
})
.width(50)
@ -108,5 +118,10 @@ public class EditProfileScreen extends Screen {
public void onClose() {
this.minecraft.setScreen(this.profilesScreen);
this.profilesScreen.profilesList.refreshEntries();
// Checks if the configuration still exists and wasn't deleted
if (Files.exists(Profiles.PROFILES_DIRECTORY.resolve(profileName.getString()).resolve("configuration.json"))) {
this.profileConfiguration.save();
}
}
}

View file

@ -14,10 +14,10 @@ public class OptionsToggleScreen extends OptionsSubScreen {
private OptionsToggleList optionsToggleList;
public ProfileConfiguration profileConfiguration;
protected OptionsToggleScreen(Screen lastScreen, Component profileName) {
protected OptionsToggleScreen(Screen lastScreen, Component profileName, ProfileConfiguration profileConfiguration) {
super(lastScreen, null, Component.literal(Component.translatable("gui.optionsprofiles.options-toggle").append(": ").getString() + profileName.getString()));
this.profileName = profileName;
this.profileConfiguration = ProfileConfiguration.get(profileName.getString());
this.profileConfiguration = profileConfiguration;
}
protected void addOptions() {}

View file

@ -81,7 +81,7 @@ public class ProfilesList extends ContainerObjectSelectionList<ProfilesList.Prof
this.loadButton = Button.builder(
Component.translatable("gui.optionsprofiles.load-profile"),
(button) -> {
Profiles.loadProfile(profileName.getString());
OptionsProfilesMod.PROFILES_INSTANCE.loadProfile(profileName.getString());
minecraft.options.load();
@ -124,7 +124,7 @@ public class ProfilesList extends ContainerObjectSelectionList<ProfilesList.Prof
}
protected void checkLoaded() {
this.loadButton.active = !Profiles.isProfileLoaded(profileName.getString());
this.loadButton.active = !OptionsProfilesMod.PROFILES_INSTANCE.isProfileLoaded(profileName.getString());
}
}
}

View file

@ -1,5 +1,6 @@
package com.axolotlmaid.optionsprofiles.gui;
import com.axolotlmaid.optionsprofiles.OptionsProfilesMod;
import com.axolotlmaid.optionsprofiles.profiles.Profiles;
import net.minecraft.client.gui.components.Button;
import net.minecraft.client.gui.layouts.LinearLayout;
@ -10,7 +11,7 @@ import net.minecraft.network.chat.CommonComponents;
import net.minecraft.network.chat.Component;
public class ProfilesScreen extends OptionsSubScreen {
private Screen optionsLastScreen;
private final Screen optionsLastScreen;
public ProfilesList profilesList;
public ProfilesScreen(Screen lastScreen, Screen optionsLastScreen) {
@ -31,7 +32,7 @@ public class ProfilesScreen extends OptionsSubScreen {
Button.builder(
Component.translatable("gui.optionsprofiles.save-current-options"),
(button -> {
Profiles.createProfile();
OptionsProfilesMod.PROFILES_INSTANCE.createProfile();
this.profilesList.refreshEntries();
}))
.build()

View file

@ -17,8 +17,7 @@ public class ProfileConfiguration {
private static Path configurationFile;
private static String profileName;
public static int configurationVersion = 1; // Used to update configuration in later revisions
private int version = configurationVersion; // ^ same here - this variable is used to show it in the configuration.json file
private boolean loadOnStartup = false;
private List<String> optionsToLoad = new ArrayList<>();
public ProfileConfiguration save() {
@ -59,12 +58,12 @@ public class ProfileConfiguration {
return configuration;
}
public int getVersion() {
return version;
public boolean isLoadOnStartup() {
return loadOnStartup;
}
public void setVersion(int version) {
this.version = version;
public void setLoadOnStartup(boolean loadOnStartup) {
this.loadOnStartup = loadOnStartup;
}
public List<String> getOptionsToLoad() {

View file

@ -5,28 +5,46 @@ import com.axolotlmaid.optionsprofiles.profiles.loaders.DistantHorizonsLoader;
import com.axolotlmaid.optionsprofiles.profiles.loaders.EmbeddiumLoader;
import com.axolotlmaid.optionsprofiles.profiles.loaders.SodiumExtraLoader;
import com.axolotlmaid.optionsprofiles.profiles.loaders.SodiumLoader;
import nl.enjarai.shared_resources.api.GameResourceHelper;
import nl.enjarai.shared_resources.util.GameResourceConfig;
import org.apache.commons.io.FileUtils;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardCopyOption;
import java.nio.file.*;
import java.util.*;
import java.util.function.Consumer;
import java.util.stream.Stream;
public class Profiles {
public static final Path PROFILES_DIRECTORY = Paths.get("options-profiles/");
public static final Path OPTIONS_FILE = Paths.get("options.txt");
public static Path PROFILES_DIRECTORY = Paths.get("options-profiles/");
public static Path OPTIONS_FILE = Paths.get("options.txt");
public static final Path OPTIFINE_OPTIONS_FILE = Paths.get("optionsof.txt");
public static final Path SODIUM_OPTIONS_FILE = Paths.get("config/sodium-options.json");
public static final Path SODIUM_EXTRA_OPTIONS_FILE = Paths.get("config/sodium-extra-options.json");
public static final Path EMBEDDIUM_OPTIONS_FILE = Paths.get("config/embeddium-options.json");
public static final Path DISTANT_HORIZONS_OPTIONS_FILE = Paths.get("config/DistantHorizons.toml");
// This function goes through every profile and updates / adds the configuration file if it doesn't exist
public static void updateProfiles() {
public Profiles() {
// Create profiles directory
PROFILES_DIRECTORY = Paths.get("options-profiles/");
if (Files.notExists(PROFILES_DIRECTORY)) {
try {
Files.createDirectory(PROFILES_DIRECTORY);
} catch (IOException e) {
OptionsProfilesMod.LOGGER.error("An error occurred when creating the 'options-profiles' directory.", e);
}
}
// Set profiles directory if Shared Resources mod is installed
Path sharedResourcesPath = GameResourceHelper.getPathFor(SharedResourcesProfiles.SHARED_RESOURCES_PROFILES_DIRECTORY);
if (sharedResourcesPath != null) {
PROFILES_DIRECTORY = sharedResourcesPath;
OPTIONS_FILE = sharedResourcesPath.getParent().resolve("options.txt");
}
// Goes through every profile and adds the configuration file if it doesn't exist
try (Stream<Path> paths = Files.list(PROFILES_DIRECTORY)) {
paths.filter(Files::isDirectory)
.forEach(path -> {
@ -34,36 +52,47 @@ public class Profiles {
// This gets the configuration but also creates the configuration file if it is not there
ProfileConfiguration profileConfiguration = ProfileConfiguration.get(profileName);
Path profile = PROFILES_DIRECTORY.resolve(profileName);
Path profileOptions = profile.resolve(OPTIONS_FILE.getFileName());
// Add every option value to configuration
try (Stream<String> lines = Files.lines(profileOptions)) {
List<String> optionsToLoad = profileConfiguration.getOptionsToLoad();
// Checks for updates to the configuration
if (profileConfiguration.getVersion() != ProfileConfiguration.configurationVersion) {
Path configurationFile = path.resolve("configuration.json");
lines.forEach((line) -> {
String[] option = line.split(":");
optionsToLoad.add(option[0]);
});
try {
Files.delete(configurationFile);
} catch (IOException e) {
OptionsProfilesMod.LOGGER.error("[Profile '{}']: Error deleting configuration file", profileName, e);
}
// Create the configuration.json again thus updating it
profileConfiguration = ProfileConfiguration.get(profileName);
// Add player's old configuration
profileConfiguration.setOptionsToLoad(optionsToLoad);
// Save configuration
profileConfiguration.save();
} catch (IOException e) {
OptionsProfilesMod.LOGGER.error("[Profile '{}']: An error occurred when adding options to the configuration file", profileName, e);
}
OptionsProfilesMod.LOGGER.warn("[Profile '{}']: Profile configuration updated / added", profileName);
OptionsProfilesMod.LOGGER.warn("[Profile '{}']: Profile configuration added", profileName);
});
} catch (IOException e) {
OptionsProfilesMod.LOGGER.error("An error occurred when updating profiles", e);
}
// Loading profiles on startup
try (DirectoryStream<Path> directoryStream = Files.newDirectoryStream(Profiles.PROFILES_DIRECTORY)) {
for (Path profile : directoryStream) {
String profileName = profile.getFileName().toString();
ProfileConfiguration profileConfiguration = ProfileConfiguration.get(profileName);
if (profileConfiguration.isLoadOnStartup()) {
OptionsProfilesMod.PROFILES_INSTANCE.loadProfile(profileName);
}
}
} catch (Exception e) {
OptionsProfilesMod.LOGGER.error("An error occurred when loading startup profiles", e);
}
public static void createProfile() {
return;
}
public void createProfile() {
String profileName = "Profile 1";
Path profile = PROFILES_DIRECTORY.resolve(profileName);
@ -87,7 +116,7 @@ public class Profiles {
}
}
private static void copyOptionFile(Path profile, Path options) {
private void copyOptionFile(Path profile, Path options) {
if (Files.exists(options)) {
Path profileOptions = profile.resolve(options.getFileName());
@ -100,7 +129,7 @@ public class Profiles {
}
}
public static void writeProfile(String profileName, boolean overwriting) {
public void writeProfile(String profileName, boolean overwriting) {
Path profile = PROFILES_DIRECTORY.resolve(profileName);
Path profileOptions = profile.resolve("options.txt");
@ -146,13 +175,13 @@ public class Profiles {
}
}
public static boolean isProfileLoaded(String profileName) {
public boolean isProfileLoaded(String profileName) {
Path profile = PROFILES_DIRECTORY.resolve(profileName);
List<Path> optionFiles = new ArrayList<>();
optionFiles.add(OPTIONS_FILE);
// The next few lines check if the specified file exists. If so, it adds it to the optionFiles ArrayList.
// These lines check if the specified file exists. If so, it adds it to the optionFiles ArrayList.
Optional.of(OPTIFINE_OPTIONS_FILE).filter(Files::exists).ifPresent(optionFiles::add);
Optional.of(SODIUM_OPTIONS_FILE).filter(Files::exists).ifPresent(optionFiles::add);
Optional.of(SODIUM_EXTRA_OPTIONS_FILE).filter(Files::exists).ifPresent(optionFiles::add);
@ -175,7 +204,7 @@ public class Profiles {
return true;
}
private static void loadOptionFile(String profileName, Path options) {
private void loadOptionFile(String profileName, Path options) {
ProfileConfiguration profileConfiguration = ProfileConfiguration.get(profileName);
Path profile = PROFILES_DIRECTORY.resolve(profileName);
@ -244,7 +273,7 @@ public class Profiles {
}
}
private static void loadOptionFile(String profileName, Path options, Consumer<Path> loader) {
private void loadOptionFile(String profileName, Path options, Consumer<Path> loader) {
Path profile = PROFILES_DIRECTORY.resolve(profileName);
Path profileOptions = profile.resolve(options.getFileName());
@ -254,7 +283,7 @@ public class Profiles {
}
}
public static void loadProfile(String profileName) {
public void loadProfile(String profileName) {
loadOptionFile(profileName, OPTIONS_FILE);
loadOptionFile(profileName, OPTIFINE_OPTIONS_FILE);
loadOptionFile(profileName, SODIUM_OPTIONS_FILE, SodiumLoader::load);
@ -265,7 +294,7 @@ public class Profiles {
loadOptionFile(profileName, DISTANT_HORIZONS_OPTIONS_FILE, DistantHorizonsLoader::load); // Tell Distant Horizons mod to reload configuration
}
public static void renameProfile(String profileName, String newProfileName) {
public void renameProfile(String profileName, String newProfileName) {
Path profile = PROFILES_DIRECTORY.resolve(profileName);
Path newProfile = PROFILES_DIRECTORY.resolve(newProfileName);
@ -282,7 +311,7 @@ public class Profiles {
}
}
public static void deleteProfile(String profileName) {
public void deleteProfile(String profileName) {
Path profile = PROFILES_DIRECTORY.resolve(profileName);
try {

View file

@ -0,0 +1,21 @@
package com.axolotlmaid.optionsprofiles.profiles;
import net.minecraft.network.chat.Component;
import nl.enjarai.shared_resources.api.GameResourceRegistry;
import nl.enjarai.shared_resources.api.ResourceDirectory;
import nl.enjarai.shared_resources.api.ResourceDirectoryBuilder;
import nl.enjarai.shared_resources.api.SharedResourcesEntrypoint;
import net.minecraft.resources.ResourceLocation;
public class SharedResourcesProfiles implements SharedResourcesEntrypoint {
public static final ResourceDirectory SHARED_RESOURCES_PROFILES_DIRECTORY = new ResourceDirectoryBuilder("options-profiles")
.setDisplayName(Component.translatable("gui.optionsprofiles"))
.defaultEnabled(true)
.isExperimental()
.build();
@Override
public void registerResources(GameResourceRegistry registry) {
registry.register(ResourceLocation.fromNamespaceAndPath("optionsprofiles", "profiles_directory"), SHARED_RESOURCES_PROFILES_DIRECTORY);
}
}

View file

@ -1,4 +1,6 @@
{
"gui.optionsprofiles": "Options Profiles",
"gui.optionsprofiles.profiles-menu": "Profiles",
"gui.optionsprofiles.save-current-options": "Save Current Options",
"gui.optionsprofiles.load-profile": "✔ (Load)",

View file

@ -18,6 +18,9 @@
"entrypoints": {
"main": [
"com.axolotlmaid.optionsprofiles.fabric.OptionsProfilesModFabric"
],
"shared-resources": [
"com.axolotlmaid.optionsprofiles.profiles.SharedResourcesProfiles"
]
},
"mixins": [