135 lines
5.5 KiB
Java
135 lines
5.5 KiB
Java
/*
|
|
* MIT License
|
|
*
|
|
* Copyright (c) 2022 Griefed
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in all
|
|
* copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*
|
|
*/
|
|
package de.griefed.exampleaddon.gui.panel;
|
|
|
|
import com.electronwill.nightconfig.core.CommentedConfig;
|
|
import de.griefed.serverpackcreator.ApplicationProperties;
|
|
import de.griefed.serverpackcreator.ServerPackHandler;
|
|
import de.griefed.serverpackcreator.addons.swinggui.ConfigPanelExtension;
|
|
import de.griefed.serverpackcreator.addons.swinggui.ExtensionConfigPanel;
|
|
import de.griefed.serverpackcreator.swing.TabCreateServerPack;
|
|
import de.griefed.serverpackcreator.utilities.common.Utilities;
|
|
import de.griefed.serverpackcreator.versionmeta.VersionMeta;
|
|
import java.util.Optional;
|
|
import org.pf4j.Extension;
|
|
|
|
@Extension
|
|
public class Panel implements ConfigPanelExtension {
|
|
|
|
/**
|
|
* This method gets called when an extension of this type is run. All parameters are provided by
|
|
* ServerPackCreator, so you do not have to take care of them. A ConfigPanel is intended to be
|
|
* used to change server pack-specific configurations which can then be used by other extensions
|
|
* in your plugin. A simple example would be downloading a specific version of some mod. You could
|
|
* add a panel which lets the user configure the version of the mod to use. When the user then
|
|
* runs the server pack generation, your setting will be stored in the subsequently generated
|
|
* serverpackcreator.conf, and could be used in any of the {@link ServerPackHandler}
|
|
* extension-points, which would then download the version you specified via this here panel.
|
|
*
|
|
* @param versionMeta Instance of {@link VersionMeta} so you can work with available
|
|
* Minecraft, Forge, Fabric, LegacyFabric and Quilt versions.
|
|
* @param applicationProperties Instance of {@link ApplicationProperties} The current
|
|
* configuration of ServerPackCreator, like the default list of
|
|
* clientside-only mods, the server pack directory etc.
|
|
* @param utilities Instance of {@link Utilities} commonly used across
|
|
* ServerPackCreator.
|
|
* @param tabCreateServerPack Instance of {@link TabCreateServerPack} to give you access to the
|
|
* various fields inside it, like the modpack directory, selected
|
|
* Minecraft, modloader and modloader versions, etc.
|
|
* @param addonConfig Addon specific configuration conveniently provided by
|
|
* ServerPackCreator. This is the global configuration of the addon
|
|
* which provides the ConfigPanelExtension to ServerPackCreator.
|
|
* @param extensionName The name the titled border of this ConfigPanel will get.
|
|
* @param pluginID The same as the PluginId.
|
|
* @return A ConfigPanel allowing users to further customize their ServerPackCreator experience
|
|
* when using an addon.
|
|
* @author Griefed
|
|
*/
|
|
@Override
|
|
public ExtensionConfigPanel getPanel(VersionMeta versionMeta,
|
|
ApplicationProperties applicationProperties, Utilities utilities,
|
|
TabCreateServerPack tabCreateServerPack, Optional<CommentedConfig> addonConfig,
|
|
String extensionName, String pluginID) {
|
|
return new ConfigurationPanel(versionMeta, applicationProperties, utilities,
|
|
tabCreateServerPack, addonConfig, extensionName, pluginID);
|
|
}
|
|
|
|
/**
|
|
* Get the name of this addon.
|
|
*
|
|
* @return The name of this addon.
|
|
* @author Griefed
|
|
*/
|
|
@Override
|
|
public String getName() {
|
|
return "Example Config Panel Extension";
|
|
}
|
|
|
|
/**
|
|
* Get the description of this addon.
|
|
*
|
|
* @return The description of this addon.
|
|
* @author Griefed
|
|
*/
|
|
@Override
|
|
public String getDescription() {
|
|
return "An example for an extension which adds a server pack specific addon extension configuration panel.";
|
|
}
|
|
|
|
/**
|
|
* Get the author of this addon.
|
|
*
|
|
* @return The author of this addon.
|
|
* @author Griefed
|
|
*/
|
|
@Override
|
|
public String getAuthor() {
|
|
return "Griefed";
|
|
}
|
|
|
|
/**
|
|
* Get the version of this addon.
|
|
*
|
|
* @return The version of this addon.
|
|
* @author Griefed
|
|
*/
|
|
@Override
|
|
public String getVersion() {
|
|
return "0.0.1-SNAPSHOT";
|
|
}
|
|
|
|
/**
|
|
* Get the if of this extension. Used by ServerPackCreator to determine which configuration, if
|
|
* any, to provide to any given extension being run.
|
|
*
|
|
* @return The ID of this extension.
|
|
* @author Griefed
|
|
*/
|
|
@Override
|
|
public String getExtensionId() {
|
|
return "configpanelexample";
|
|
}
|
|
}
|