rl-client: implement our pf4j plugins, extract pf4j out of net.runelite package. (#2883)

2020-12-26 19:28:30 -05:00
parent 7c021d2dcc
commit 53fe72452a
35 changed files with 4046 additions and 41 deletions
--- a/runelite-client/src/main/java/com/openosrs/client/config/OpenOSRSConfig.java
+++ b/runelite-client/src/main/java/com/openosrs/client/config/OpenOSRSConfig.java
@@ -0,0 +1,160 @@
+/*
+ *
+ *   Copyright (c) 2019, Zeruth <TheRealNull@gmail.com>
+ *   All rights reserved.
+ *
+ *   Redistribution and use in source and binary forms, with or without
+ *   modification, are permitted provided that the following conditions are met:
+ *
+ *   1. Redistributions of source code must retain the above copyright notice, this
+ *      list of conditions and the following disclaimer.
+ *   2. Redistributions in binary form must reproduce the above copyright notice,
+ *      this list of conditions and the following disclaimer in the documentation
+ *      and/or other materials provided with the distribution.
+ *
+ *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ *   ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ *   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ *   DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ *   ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ *   (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ *   LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ *   ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ *   SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+package com.openosrs.client.config;
+
+import lombok.AccessLevel;
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import net.runelite.client.config.Config;
+import net.runelite.client.config.ConfigGroup;
+import net.runelite.client.config.ConfigItem;
+import net.runelite.client.config.Keybind;
+import net.runelite.client.config.Range;
+import net.runelite.client.config.Units;
+import com.openosrs.client.plugins.ExternalPluginManager;
+
+@ConfigGroup("openosrs")
+public interface OpenOSRSConfig extends Config
+{
+	@Getter(AccessLevel.PUBLIC)
+	@AllArgsConstructor
+	enum SortStyle
+	{
+		CATEGORY("Category"),
+		ALPHABETICALLY("Alphabetically"),
+		REPOSITORY("Repository");
+
+		private String name;
+
+		@Override
+		public String toString()
+		{
+			return getName();
+		}
+	}
+
+	@ConfigItem(
+		position = 3,
+		keyName = "shareLogs",
+		name = "Share anonymous error data",
+		description = "Share anonymous error data with the OpenOSRS developers"
+	)
+	default boolean shareLogs()
+	{
+		return true;
+	}
+
+	@ConfigItem(
+		keyName = "enableOpacity",
+		name = "Enable opacity",
+		description = "Enables opacity for the whole window.<br>NOTE: This only stays enabled if your pc supports this!",
+		position = 18
+	)
+	default boolean enableOpacity()
+	{
+		return false;
+	}
+
+	@Range(
+		min = 15,
+		max = 100
+	)
+	@ConfigItem(
+		keyName = "opacityPercentage",
+		name = "Opacity percentage",
+		description = "Changes the opacity of the window if opacity is enabled",
+		position = 19
+	)
+	@Units(Units.PERCENT)
+	default int opacityPercentage()
+	{
+		return 100;
+	}
+
+	@ConfigItem(
+		keyName = "localSync",
+		name = "Sync local instances",
+		description = "Enables multiple local instances of OpenOSRS to communicate (this enables syncing plugin state and config options)",
+		position = 21
+	)
+	default boolean localSync()
+	{
+		return true;
+	}
+
+	@ConfigItem(
+		keyName = "keyboardPin",
+		name = "Keyboard bank pin",
+		description = "Enables you to type your bank pin",
+		position = 22
+	)
+	default boolean keyboardPin()
+	{
+		return false;
+	}
+
+	@ConfigItem(
+		keyName = "detachHotkey",
+		name = "Detach Cam",
+		description = "Detach Camera hotkey, press this and it will activate detatched camera.",
+		position = 23
+	)
+	default Keybind detachHotkey()
+	{
+		return Keybind.NOT_SET;
+	}
+
+	@ConfigItem(
+		keyName = "externalRepositories",
+		name = "",
+		description = "",
+		hidden = true
+	)
+	default String getExternalRepositories()
+	{
+		return ExternalPluginManager.DEFAULT_PLUGIN_REPOS;
+	}
+
+	@ConfigItem(
+		keyName = "externalRepositories",
+		name = "",
+		description = "",
+		hidden = true
+	)
+	void setExternalRepositories(String val);
+
+	@ConfigItem(
+		keyName = "warning",
+		name = "",
+		description = "",
+		hidden = true
+	)
+	default boolean warning()
+	{
+		return true;
+	}
+}