Mirror/Grasscutter
1
0
Fork 0
mirror of https://github.com/Grasscutters/Grasscutter.git synced 2026-04-04 06:52:27 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge unstable into development (#2173)

Browse Source 
* Remove more scene synchronized

* Fix worktop options not appearing

* Format code [skip actions]

* Fix delay with server tasks

* Format code [skip actions]

* Fully fix fairy clock (#2146)

* Fix scene transition

* fully fix fairy clock

* Re-add call to `Player#updatePlayerGameTime`

* Format code [skip actions]

* Initialize the script loader in `ResourceLoader#loadAll`

* Fix region removal checking

* Format code [skip actions]

* Use Lombok's `EqualsAndHashCode` for comparing scene regions

* Format code [skip actions]

* Move 'invalid gather object' to `trace`

* Add more information to the 'unknown condition handler' message

* Move invalid ability action to trace

* Make `KcpTunnel` public

* Validate the NPC being talked to

* Format code [skip actions]

* NPCs are not spawned server side; change logic to handle it

* Format code [skip actions]

* unload scene when there are no players (#2147)

* unload scene when there are no players

* Update src/main/java/emu/grasscutter/game/world/Scene.java

Co-authored-by: Magix <27646710+KingRainbow44@users.noreply.github.com>

---------

Co-authored-by: Magix <27646710+KingRainbow44@users.noreply.github.com>

* Check if a command should be copied or HTTP should be used

* Lint Code [skip actions]

* Fix character names rendering incorrectly

* Add basic troubleshooting command

* Implement handbook teleporting

also a few formatting changes and sort data by logical sense

* Fix listener `ConcurrentModificationException` issue

* Add color change to `Join the Community!`

* Lint Code [skip actions]

* Make clickable buttons appear clickable

* Remove 'Mechanicus' entities from the list of entities

* Format code [skip actions]

* Fix going back returning a blank screen

* Implement entity spawning

* Add setting level to entity card

* Add support for 'plain text' mode

* Make descriptions of objects scrollable

* Lint Code [skip actions]

* Format code [skip actions]

* Change the way existing hooks work

* Format code [skip actions]

* Upgrade Javalin to 5.5.0 & Fix project warnings

* Upgrade logging libraries

* Fix gacha mappings static file issue

* Add temporary backwards compatability for `ServerHelper`

* Format code [skip actions]

* Remove artifact signatures from VCS

* Fix forge queue data protocol definition

* Run `spotlessApply`

* Format code [skip actions]

* Download data required for building artifacts

* Add call for Facebook logins

* Add the wiki page as a submodule

* Format code [skip actions]

* Update translation (#2150)

* Update translation

* Update translation

* Separate the dispatch and game servers (pt. 1)

gacha is still broken, handbook still needs to be done

* Format code [skip actions]

* Separate the dispatch and game servers (pt. 2)

this commit fixes the gacha page

* Add description for '/troubleshoot'

* Set default avatar talent level to 10

* Separate the dispatch and game servers (pt. 3)

implement handbook across servers!

* Format code [skip actions]

* Update GitHub Actions to use 'download-file' over 'wget'

* Gm handbook lmao (#2149)

* Fix font issue

* Fix avatars

* Fix text overflow in commands

* Fix virtualized lists and items page 😭😭

* magix why 💀

* use hover style in all minicards

* button

* remove console.log

* lint

* Add icons

* magix asked

* Fix overflow padding issue

* Fix achievement text overflow

* remove icons from repo

* Change command icon

* Add the wiki page as a submodule

* total magix moment

* fix text overflow in commands

* Fix discord button

* Make text scale on Minicard

* import icons and font from another source

* Add hover effects to siebar buttons

* move font and readme to submodule repo

* Make data folder a submodule

* import icons and font from data submodule

* Update README.md

* total magix moment

* magix moment v2

* submodule change

* Import `.webp` files

* Resize `HomeButton`

* Fix 'Copy Command' reappearing after changing pages

---------

Co-authored-by: KingRainbow44 <kobedo11@gmail.com>

* Lint Code [skip actions]

* Download data for the build, not for the lint

* format imports

this is really just to see if build handbook works kek

* Implement proper handbook authentication (pt. 1)

* Implement proper handbook authentication (pt. 2)

* Format code [skip actions]

* Add quest data dumping for the handbook

* Change colors to fit _something suitable_

* Format code [skip actions]

* Fix force pushing to branches after linting

* Fix logic of `SetPlayerPropReq`

* Move more group loading to `trace`

* Add handbook IP authentication in hybrid mode

* Fix player level up not displaying on the client properly

* Format code [skip actions]

* Fix game time locking

* Format code [skip actions]

* Update player properties

* Format code [skip actions]

* Move `warn`s for groups to `debug`

* Fix player pausing

* Move more logs to `trace`

* Use `removeItemById` for deleting items via quests

* Clean up logger more

* Pause in-game time when the world is paused

* Format code [skip actions]

* More player property documentation

* Multi-threaded resource loading

* Format code [skip actions]

* Add quest widgets

* Add quests page (basic impl.)

* Add/fix colors

also fix tailwind

* Remove banned packets

client modifications already perform the job of blocking malicious packets from being executed, no point in having this if self-windy is wanted

* Re-add `BeginCameraSceneLookNotify`

* Fix being unable to attack (#2157)

* Add `PlayerOpenChestEvent`

* Add methods to get players from the server

* Add static methods to register an event handler

* Add `PlayerEnterDungeonEvent`

* Remove legacy documentation from `PlayerMoveEvent`

* Add `PlayerChatEvent`

* Add defaults to `Position`

* Clean up `.utils`

* Revert `Multi-threaded resource loading`

* Fix changing target UID when talking to the server

* Lint Code [skip actions]

* Format code [skip actions]

* fix NPC talk triggering main quest in 46101 (#2158)

Make it so that only talks where the param matches the talkId are checked.

* Format code [skip actions]

* Partially fix Chasing Shadows (#2159)

* Partially fix Chasing Shadows

* Go ahead and move it before the return before Magix tells me to.

* Format code [skip actions]

* Bring back period lol (#2160)

* Disable SNI for the HTTPS server

* Add `EntityCreationEvent`

* Add initial startup message

this is so the server appears like its preparing to start

* Format code [skip actions]

* Enable debug mode for plugin loggers if enabled for the primary logger

* Add documentation about `WorldAreaConfigData`

* Make more fields in excels accessible

* Remove deprecated fields from `GetShopRsp`

* Run `spotlessApply` on definitions

* Add `PlayerEnterAreaEvent`

* Optimize event calls

* Fix event invokes

* Format code [skip actions]

* Remove manual autofinish for main quests. (#2162)

* Add world areas to the textmap cache

* Format code [skip actions]

* Don't overdefine variables in extended classes (#2163)

* Add dumper for world areas

* Format code [skip actions]

* instantiate personalLineList (#2165)

* Fix protocol definitions

thank you Nazrin! (+ hiro for raw definitions)

* Fix the background color leaking from the character widget

* Change HTML spacing to 2 spaces

* Implement hiding widgets

* Change scrollbar to a vibrant color

* Add _some_ scaling to the home buttons and its text

* Build the handbook with Gradle

* Fix the 'finer details' with the handbook UI

* Lint Code [skip actions]

* Fix target destination for the Gradle-built handbook

* Implement fetching a player across servers & Add a chainable JsonObject

useful for plugins! might be used in grasscutter eventually

* Fix GitHub actions

* Fix event calling & canceling

* Run `spotlessApply`

* Rename fields (might be wrong)

* Add/update all/more protocol definitions

* Add/update all/more protocol definitions

* Remove outdated packet

* Fix protocol definitions

* Format code [skip actions]

* Implement some lua variables for less console spam (#2172)

* Implement some lua variables for less console spam

* Add GetHostQuestState

This fixes some chapter 3 stuff.

* Format code [skip actions]

* Fix merge import

* Format code [skip actions]

* Fully fix fairy clock for real this time (#2167)

* Fully fix fairy clock For real this time

* Make it so relogging keeps the time lock state.

* Refactor out questLockTime

* Per Hartie, the client packet needs to be changed too

* Update src/main/java/emu/grasscutter/game/world/World.java

Co-authored-by: Magix <27646710+KingRainbow44@users.noreply.github.com>

* Update src/main/java/emu/grasscutter/server/packet/recv/HandlerClientLockGameTimeNotify.java

* Remove all code not needed to get clock working

---------

Co-authored-by: Magix <27646710+KingRainbow44@users.noreply.github.com>

* Implement a proper ability system (#2166)

* Apply fix `21dec2fe`

* Apply fix `89d01d5f`

* Apply fix `d900f154`

this one was already implemented; updated to use call from previous commit

* Ability changing commit

TODO: change info to debug

* Remove use of deprecated methods/fields

* Temp commit v2
(Adding LoseHP and some fixes)

* Oopsie

* Probably fix monster battle

* Fix issue with reflecting into fields

* Fix some things

* Fix ability names for 3.6 resources

* Improve logging

---------

Co-authored-by: StartForKiller <jesussanz2003@gmail.com>

* Format code [skip actions]

* Add system for sending messages between servers

* Format some code

* Remove protocol definitions from Spotless

* Default debug to false; enable with `-debug`

* Implement completely useless global value copying

* HACK: Return the avatar which holds the weapon when the weapon is referred to by ID

* Add properties to `AbilityModifier`

* Change the way HTML is served after authentication

* Use thread executors to speed up the database loading process

* Format code [skip actions]

* Add system for setting handbook address and port

* Lint Code [skip actions]

* Format code [skip actions]

* Fix game-related data not saving

* Format code [skip actions]

* Fix handbook server details

* Lint Code [skip actions]

* Format code [skip actions]

* Use the headers provided by a context to get the IP address

should acknowledge #1975

* Format code [skip actions]

* Move more logs to `trace`

* Format code [skip actions]

* more trace

* Fix something and implement weapon entities

* Format code [skip actions]

* Fix `EntityWeapon`

* Remove deprecated API & Fix resource checking

* Fix unnecessary warning for first-time setup

* Implement handbook request limiting

* Format code [skip actions]

* Fix new avatar weapons being null

* Format code [skip actions]

* Fix issue with 35303 being un-completable & Try to fix fulfilled quest conditions being met

* Load activity config on server startup

* Require plugins to specify an API version and match with the server

* Add default open state ignore list

* Format code [skip actions]

* Quick fix for questing, needs more investigation
This would make the questing work again

* Remove existing hack for 35303

* Fix ignored open states from being set

* Format code [skip actions]

* fix the stupidest bug ive ever seen

* Optimize player kicking on server close

* Format code [skip actions]

* Re-add hack to fix 35303

* Update GitHub actions

* Format code [skip actions]

* Potentially fix issues with regions

* Download additional handbook data

* Revert "Potentially fix issues with regions"

This reverts commit 84e3823695.

---------

Co-authored-by: github-actions <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: scooterboo <lewasite@yahoo.com>
Co-authored-by: Tesutarin <105267106+Tesutarin@users.noreply.github.com>
Co-authored-by: Scald <104459145+Arikatsu@users.noreply.github.com>
Co-authored-by: StartForKiller <jesussanz2003@gmail.com>
This commit is contained in:
Magix
2023-05-31 20:48:16 -07:00
committed by GitHub
parent f46fd372d2
commit 9e5b57a043
3839 changed files with 1841548 additions and 37533 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
src/main/java/emu/grasscutter/plugin/Plugin.java
View File

@@ -1,22 +1,19 @@
package emu.grasscutter.plugin;
import ch.qos.logback.classic.Level;
import emu.grasscutter.Grasscutter;
import emu.grasscutter.plugin.api.ServerHook;
import emu.grasscutter.plugin.api.ServerHelper;
import emu.grasscutter.server.game.GameServer;
import emu.grasscutter.utils.FileUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.io.File;
import java.io.InputStream;
import java.io.*;
import java.net.URLClassLoader;
import lombok.EqualsAndHashCode;
import org.slf4j.*;
/**
* The base class for all plugins to extend.
*/
/** The base class for all plugins to extend. */
@EqualsAndHashCode
public abstract class Plugin {
private final ServerHook server = ServerHook.getInstance();
private final ServerHelper server = ServerHelper.getInstance();
private PluginIdentifier identifier;
private URLClassLoader classLoader;
@@ -26,9 +23,11 @@ public abstract class Plugin {
/**
* This method is reflected into.
*
* Set plugin variables.
* <p>Set plugin variables.
*
* @param identifier The plugin's identifier.
*/
@SuppressWarnings("unused")
private void initializePlugin(PluginIdentifier identifier, URLClassLoader classLoader) {
if (this.identifier != null) {
Grasscutter.getLogger().warn(this.identifier.name + " had a reinitialization attempt.");
@@ -40,43 +39,43 @@ public abstract class Plugin {
this.dataFolder = FileUtils.getPluginPath(identifier.name).toFile();
this.logger = LoggerFactory.getLogger(identifier.name);
// Check if the logger should be set in debug mode.
if (Grasscutter.getLogger().isDebugEnabled())
((ch.qos.logback.classic.Logger) logger).setLevel(Level.DEBUG);
if (!this.dataFolder.exists() && !this.dataFolder.mkdirs()) {
Grasscutter.getLogger().warn("Failed to create plugin data folder for " + this.identifier.name);
return;
Grasscutter.getLogger()
.warn("Failed to create plugin data folder for " + this.identifier.name);
}
}
/**
* The plugin's identifier instance.
*
* @return An instance of {@link PluginIdentifier}.
*/
public final PluginIdentifier getIdentifier() {
return this.identifier;
}
/**
* Get the plugin's name.
*/
/** Get the plugin's name. */
public final String getName() {
return this.identifier.name;
}
/**
* Get the plugin's description.
*/
/** Get the plugin's description. */
public final String getDescription() {
return this.identifier.description;
}
/**
* Get the plugin's version.
*/
/** Get the plugin's version. */
public final String getVersion() {
return this.identifier.version;
}
/**
* Returns the server that initialized the plugin.
*
* @return A server instance.
*/
public final GameServer getServer() {
@@ -85,6 +84,7 @@ public abstract class Plugin {
/**
* Returns an input stream for a resource in the JAR file.
*
* @param resourceName The name of the resource.
* @return An input stream.
*/
@@ -94,6 +94,7 @@ public abstract class Plugin {
/**
* Returns a directory where plugins can store data files.
*
* @return A directory on the file system.
*/
public final File getDataFolder() {
@@ -102,14 +103,16 @@ public abstract class Plugin {
/**
* Returns the server hook.
*
* @return A server hook singleton.
*/
public final ServerHook getHandle() {
public final ServerHelper getHandle() {
return this.server;
}
/**
* Returns the plugin's logger.
*
* @return A SLF4J logger.
*/
public final Logger getLogger() {
@@ -117,9 +120,11 @@ public abstract class Plugin {
}
/* Called when the plugin is first loaded. */
public void onLoad() { }
public void onLoad() {}
/* Called after (most of) the server enables. */
public void onEnable() { }
public void onEnable() {}
/* Called before the server disables. */
public void onDisable() { }
public void onDisable() {}
}

8
src/main/java/emu/grasscutter/plugin/PluginConfig.java
View File

@@ -1,20 +1,20 @@
package emu.grasscutter.plugin;
/**
* The data contained in the plugin's `plugin.json` file.
*/
/** The data contained in the plugin's `plugin.json` file. */
public final class PluginConfig {
public String name, description, version;
public String mainClass;
public Integer api;
public String[] authors;
public String[] loadAfter;
/**
* Attempts to validate this config instance.
*
* @return True if the config is valid, false otherwise.
*/
@SuppressWarnings("BooleanMethodIsAlwaysInverted")
public boolean validate() {
return name != null && description != null && mainClass != null;
return name != null && description != null && mainClass != null && api != null;
}
}

21
src/main/java/emu/grasscutter/plugin/PluginIdentifier.java
View File

@@ -4,26 +4,19 @@ package emu.grasscutter.plugin;
public final class PluginIdentifier {
public final String name, description, version;
public final String[] authors;
public PluginIdentifier(
String name, String description, String version,
String[] authors
) {
public PluginIdentifier(String name, String description, String version, String[] authors) {
this.name = name;
this.description = description;
this.version = version;
this.authors = authors;
}
/**
* Converts a {@link PluginConfig} into a {@link PluginIdentifier}.
*/
/** Converts a {@link PluginConfig} into a {@link PluginIdentifier}. */
public static PluginIdentifier fromPluginConfig(PluginConfig config) {
if(!config.validate())
throw new IllegalArgumentException("A valid plugin config is required to convert into a plugin identifier.");
return new PluginIdentifier(
config.name, config.description, config.version,
config.authors
);
if (!config.validate())
throw new IllegalArgumentException(
"A valid plugin config is required to convert into a plugin identifier.");
return new PluginIdentifier(config.name, config.description, config.version, config.authors);
}
}

264
src/main/java/emu/grasscutter/plugin/PluginManager.java
View File

@@ -1,50 +1,43 @@
package emu.grasscutter.plugin;
import static emu.grasscutter.utils.lang.Language.translate;
import emu.grasscutter.Grasscutter;
import emu.grasscutter.server.event.*;
import emu.grasscutter.utils.FileUtils;
import emu.grasscutter.utils.JsonUtils;
import lombok.*;
import javax.annotation.Nullable;
import static emu.grasscutter.utils.Language.translate;
import emu.grasscutter.utils.*;
import java.io.*;
import java.lang.reflect.Method;
import java.net.*;
import java.util.*;
import java.util.jar.*;
import javax.annotation.Nullable;
import lombok.*;
/**
* Manages the server's plugins and the event system.
*/
/** Manages the server's plugins and the event system. */
public final class PluginManager {
/*
* This should only be changed when a breaking change is made to the plugin API.
* A 'breaking change' is something which changes the existing logic of the API.
*/
@SuppressWarnings("FieldCanBeLocal")
private static int API_VERSION = 2;
/* All loaded plugins. */
private final Map<String, Plugin> plugins = new LinkedHashMap<>();
/* All currently registered listeners per plugin. */
private final Map<Plugin, List<EventHandler<? extends Event>>> listeners = new LinkedHashMap<>();
private final Map<Class<? extends Event>, List<EventHandler<? extends Event>>> handlers =
new LinkedHashMap<>();
public PluginManager() {
this.loadPlugins(); // Load all plugins from the plugins directory.
}
/* Data about an unloaded plugin. */
@AllArgsConstructor @Getter
static class PluginData {
private Plugin plugin;
private PluginIdentifier identifier;
private URLClassLoader classLoader;
private String[] dependencies;
}
/**
* Loads plugins from the config-specified directory.
*/
/** Loads plugins from the config-specified directory. */
private void loadPlugins() {
File pluginsDir = FileUtils.getPluginPath("").toFile();
if (!pluginsDir.exists() && !pluginsDir.mkdirs()) {
Grasscutter.getLogger().error(translate("plugin.directory_failed", pluginsDir.getAbsolutePath()));
Grasscutter.getLogger()
.error(translate("plugin.directory_failed", pluginsDir.getAbsolutePath()));
return;
}
@@ -54,18 +47,18 @@ public final class PluginManager {
return;
}
List<File> plugins = Arrays.stream(files)
.filter(file -> file.getName().endsWith(".jar"))
.toList();
List<File> plugins =
Arrays.stream(files).filter(file -> file.getName().endsWith(".jar")).toList();
URL[] pluginNames = new URL[plugins.size()];
plugins.forEach(plugin -> {
try {
pluginNames[plugins.indexOf(plugin)] = plugin.toURI().toURL();
} catch (MalformedURLException exception) {
Grasscutter.getLogger().warn(translate("plugin.unable_to_load"), exception);
}
});
plugins.forEach(
plugin -> {
try {
pluginNames[plugins.indexOf(plugin)] = plugin.toURI().toURL();
} catch (MalformedURLException exception) {
Grasscutter.getLogger().warn(translate("plugin.unable_to_load"), exception);
}
});
// Create a class loader for the plugins.
URLClassLoader classLoader = new URLClassLoader(pluginNames);
@@ -76,7 +69,7 @@ public final class PluginManager {
for (var plugin : plugins) {
try {
URL url = plugin.toURI().toURL();
try (URLClassLoader loader = new URLClassLoader(new URL[]{url})) {
try (URLClassLoader loader = new URLClassLoader(new URL[] {url})) {
// Find the plugin.json file for each plugin.
URL configFile = loader.findResource("plugin.json");
// Open the config file for reading.
@@ -84,6 +77,22 @@ public final class PluginManager {
// Create a plugin config instance from the config file.
PluginConfig pluginConfig = JsonUtils.loadToClass(fileReader, PluginConfig.class);
// Check the plugin's API version.
if (pluginConfig.api == null) {
Grasscutter.getLogger()
.warn(translate("plugin.invalid_api.not_present", plugin.getName()));
return;
} else if (pluginConfig.api != API_VERSION) {
Grasscutter.getLogger()
.warn(
translate(
"plugin.invalid_api.lower",
plugin.getName(),
pluginConfig.api,
API_VERSION));
return;
}
// Check if the plugin config is valid.
if (!pluginConfig.validate()) {
Grasscutter.getLogger().warn(translate("plugin.invalid_config", plugin.getName()));
@@ -96,8 +105,9 @@ public final class PluginManager {
Enumeration<JarEntry> entries = jarFile.entries();
while (entries.hasMoreElements()) {
JarEntry entry = entries.nextElement();
if (entry.isDirectory() || !entry.getName().endsWith(".class") || entry.getName().contains("module-info"))
continue;
if (entry.isDirectory()
|| !entry.getName().endsWith(".class")
|| entry.getName().contains("module-info")) continue;
String className = entry.getName().replace(".class", "").replace("/", ".");
classLoader.loadClass(className); // Use the same class loader for ALL plugins.
}
@@ -111,9 +121,12 @@ public final class PluginManager {
// Check if the plugin has alternate dependencies.
if (pluginConfig.loadAfter != null && pluginConfig.loadAfter.length > 0) {
// Add the plugin to a "load later" list.
dependencies.add(new PluginData(
pluginInstance, PluginIdentifier.fromPluginConfig(pluginConfig),
loader, pluginConfig.loadAfter));
dependencies.add(
new PluginData(
pluginInstance,
PluginIdentifier.fromPluginConfig(pluginConfig),
loader,
pluginConfig.loadAfter));
continue;
}
@@ -125,12 +138,14 @@ public final class PluginManager {
Grasscutter.getLogger().warn(translate("plugin.missing_config", plugin.getName()));
}
} catch (Exception exception) {
Grasscutter.getLogger().error(translate("plugin.failed_to_load_plugin", plugin.getName()), exception);
Grasscutter.getLogger()
.error(translate("plugin.failed_to_load_plugin", plugin.getName()), exception);
}
}
// Load plugins with dependencies.
int depth = 0; final int maxDepth = 30;
int depth = 0;
final int maxDepth = 30;
while (!dependencies.isEmpty()) {
// Check if the depth is too high.
if (depth >= maxDepth) {
@@ -152,9 +167,11 @@ public final class PluginManager {
dependencies.remove(pluginData);
// Load the plugin.
this.loadPlugin(pluginData.getPlugin(), pluginData.getIdentifier(), pluginData.getClassLoader());
this.loadPlugin(
pluginData.getPlugin(), pluginData.getIdentifier(), pluginData.getClassLoader());
} catch (Exception exception) {
Grasscutter.getLogger().error(translate("plugin.failed_to_load"), exception); depth++;
Grasscutter.getLogger().error(translate("plugin.failed_to_load"), exception);
depth++;
}
}
}
@@ -170,7 +187,9 @@ public final class PluginManager {
// Add the plugin's identifier.
try {
Class<Plugin> pluginClass = Plugin.class;
Method method = pluginClass.getDeclaredMethod("initializePlugin", PluginIdentifier.class, URLClassLoader.class);
Method method =
pluginClass.getDeclaredMethod(
"initializePlugin", PluginIdentifier.class, URLClassLoader.class);
method.setAccessible(true);
method.invoke(plugin, identifier, classLoader);
method.setAccessible(false);
@@ -180,49 +199,105 @@ public final class PluginManager {
// Add the plugin to the list of loaded plugins.
this.plugins.put(identifier.name, plugin);
// Create a collection for the plugin's listeners.
this.listeners.put(plugin, new ArrayList<>());
// Call the plugin's onLoad method.
try {
plugin.onLoad();
} catch (Throwable exception) {
Grasscutter.getLogger().error(translate("plugin.failed_to_load_plugin", identifier.name), exception);
Grasscutter.getLogger()
.error(translate("plugin.failed_to_load_plugin", identifier.name), exception);
}
}
/**
* Enables all registered plugins.
*/
/** Enables all registered plugins. */
public void enablePlugins() {
this.plugins.forEach((name, plugin) -> {
Grasscutter.getLogger().info(translate("plugin.enabling_plugin", name));
try {
plugin.onEnable();
} catch (Throwable exception) {
Grasscutter.getLogger().error(translate("plugin.enabling_failed", name), exception);
}
});
this.plugins.forEach(
(name, plugin) -> {
Grasscutter.getLogger().info(translate("plugin.enabling_plugin", name));
try {
plugin.onEnable();
} catch (Throwable exception) {
Grasscutter.getLogger().error(translate("plugin.enabling_failed", name), exception);
}
});
}
/**
* Disables all registered plugins.
*/
/** Disables all registered plugins. */
public void disablePlugins() {
this.plugins.forEach((name, plugin) -> {
Grasscutter.getLogger().info(translate("plugin.disabling_plugin", name));
this.disablePlugin(plugin);
});
this.plugins.forEach(
(name, plugin) -> {
Grasscutter.getLogger().info(translate("plugin.disabling_plugin", name));
this.disablePlugin(plugin);
});
}
/**
* Registers a plugin's event listener.
*
* @param plugin The plugin registering the listener.
* @param listener The event listener.
*/
public void registerListener(Plugin plugin, EventHandler<? extends Event> listener) {
this.listeners.get(plugin).add(listener);
public void registerListener(EventHandler<? extends Event> listener) {
// Check if the handlers map contains the event type.
if (!this.handlers.containsKey(listener.handles()))
this.handlers.put(listener.handles(), new LinkedList<>());
// Add the listener to the list of handlers.
this.handlers.get(listener.handles()).add(listener);
this.sortListeners(); // Sort the listeners by priority.
}
/**
* Removes all event listeners registered by the specified plugin.
*
* @param plugin The plugin.
*/
public void removeListeners(Plugin plugin) {
var newMap = new HashMap<Class<? extends Event>, List<EventHandler<? extends Event>>>();
// Remove the plugin's listeners.
this.handlers.forEach(
(event, handlers) -> {
// Add the event to the new map.
newMap.put(event, new LinkedList<>());
// Remove the plugin's listeners.
handlers.forEach(
handler -> {
if (!handler.registrar().equals(plugin)) newMap.get(event).add(handler);
});
});
// Replace the old map with the new one.
this.handlers.clear();
this.handlers.putAll(newMap);
}
/**
* Sorts the event listeners by priority. This method should be called after a listener has been
* registered.
*/
private void sortListeners() {
// Create a new map to store the sorted listeners.
var newMap = new HashMap<Class<? extends Event>, List<EventHandler<? extends Event>>>();
// Sort the listeners by priority.
this.handlers.forEach(
(event, handlers) -> {
// Add the event to the new map.
newMap.put(event, new LinkedList<>());
// Sort the handlers by priority.
var sorted =
handlers.stream()
.sorted(Comparator.comparingInt(handler -> handler.getPriority().ordinal()))
.toList();
newMap.get(event).addAll(sorted);
});
// Replace the old map with the new one.
this.handlers.clear();
this.handlers.putAll(newMap);
}
/**
@@ -231,25 +306,10 @@ public final class PluginManager {
* @param event The event to invoke.
*/
public void invokeEvent(Event event) {
EnumSet.allOf(HandlerPriority.class)
.forEach(priority -> this.checkAndFilter(event, priority));
}
var handlers = this.handlers.get(event.getClass());
if (handlers == null) return;
/**
* Check an event to handlers for the priority.
*
* @param event The event being called.
* @param priority The priority to call for.
*/
private void checkAndFilter(Event event, HandlerPriority priority) {
// Add all listeners from every plugin.
this.listeners.values().stream()
.flatMap(Collection::stream)
// Filter the listeners by priority.
.filter(handler -> handler.handles().isInstance(event))
.filter(handler -> handler.getPriority() == priority)
// Invoke the event.
.forEach(handler -> this.invokeHandler(event, handler));
handlers.forEach(handler -> this.invokeHandler(event, handler));
}
/**
@@ -258,8 +318,7 @@ public final class PluginManager {
* @param name The name of the plugin.
* @return Either null, or the plugin's instance.
*/
@Nullable
public Plugin getPlugin(String name) {
@Nullable public Plugin getPlugin(String name) {
return this.plugins.get(name);
}
@@ -273,7 +332,8 @@ public final class PluginManager {
// Call the plugin's onEnable method.
plugin.onEnable();
} catch (Exception exception) {
Grasscutter.getLogger().error(translate("plugin.enabling_failed", plugin.getName()), exception);
Grasscutter.getLogger()
.error(translate("plugin.enabling_failed", plugin.getName()), exception);
}
}
@@ -287,23 +347,33 @@ public final class PluginManager {
// Call the plugin's onDisable method.
plugin.onDisable();
} catch (Exception exception) {
Grasscutter.getLogger().error(translate("plugin.disabling_failed", plugin.getName()), exception);
Grasscutter.getLogger()
.error(translate("plugin.disabling_failed", plugin.getName()), exception);
}
// Un-register all listeners.
this.listeners.remove(plugin);
this.removeListeners(plugin);
}
/**
* Performs logic checks then invokes the provided event handler.
*
* @param event The event passed through to the handler.
* @param event The event passed through to the handler.
* @param handler The handler to invoke.
*/
@SuppressWarnings("unchecked")
private <T extends Event> void invokeHandler(Event event, EventHandler<T> handler) {
if (!event.isCanceled() ||
(event.isCanceled() && handler.ignoresCanceled())
) handler.getCallback().consume((T) event);
if (!event.isCanceled() || (event.isCanceled() && handler.ignoresCanceled()))
handler.getCallback().consume((T) event);
}
/* Data about an unloaded plugin. */
@AllArgsConstructor
@Getter
static class PluginData {
private Plugin plugin;
private PluginIdentifier identifier;
private URLClassLoader classLoader;
private String[] dependencies;
}
}

5
src/main/java/emu/grasscutter/plugin/api/Item.java
View File

@@ -1,5 +0,0 @@
package emu.grasscutter.plugin.api;
public enum Item {
/* TODO: Use handbook to generate an Item enum. */
}

81
src/main/java/emu/grasscutter/plugin/api/PlayerHook.java
View File

@@ -5,110 +5,115 @@ import emu.grasscutter.game.entity.EntityAvatar;
import emu.grasscutter.game.player.Player;
import emu.grasscutter.game.props.EnterReason;
import emu.grasscutter.game.props.FightProperty;
import emu.grasscutter.game.world.Position;
import emu.grasscutter.net.packet.BasePacket;
import emu.grasscutter.net.proto.EnterTypeOuterClass.EnterType;
import emu.grasscutter.server.packet.send.PacketAvatarFightPropUpdateNotify;
import emu.grasscutter.server.packet.send.PacketAvatarLifeStateChangeNotify;
import emu.grasscutter.server.packet.send.PacketPlayerEnterSceneNotify;
import emu.grasscutter.utils.Position;
/**
* Hooks into the {@link Player} class, adding convenient ways to do certain things.
*/
public final class PlayerHook {
private final Player player;
/** Hooks into the {@link Player} class, adding convenient ways to do certain things. */
public interface PlayerHook {
/**
* Hooks into the player.
* @param player The player to hook into.
* @return The player that this hook is attached to.
*/
public PlayerHook(Player player) {
this.player = player;
}
Player getPlayer();
/**
* Kicks a player from the server.
* TODO: Refactor to kick using a packet.
*/
public void kick() {
this.player.getSession().close();
/** Kicks a player from the server. TODO: Refactor to kick using a packet. */
default void kick() {
this.getPlayer().getSession().close();
}
/**
* Sends a player to another scene.
*
* @param sceneId The scene to send the player to.
*/
public void changeScenes(int sceneId) {
this.player.getWorld().transferPlayerToScene(this.player, sceneId, this.player.getPosition());
default void changeScenes(int sceneId) {
this.getPlayer()
.getWorld()
.transferPlayerToScene(this.getPlayer(), sceneId, this.getPlayer().getPosition());
}
/**
* Broadcasts an avatar property notify to all world players.
*
* @param property The property that was updated.
*/
public void updateFightProperty(FightProperty property) {
this.broadcastPacketToWorld(new PacketAvatarFightPropUpdateNotify(this.getCurrentAvatar(), property));
default void updateFightProperty(FightProperty property) {
this.broadcastPacketToWorld(
new PacketAvatarFightPropUpdateNotify(this.getCurrentAvatar(), property));
}
/**
* Broadcasts the packet sent to all world players.
*
* @param packet The packet to send.
*/
public void broadcastPacketToWorld(BasePacket packet) {
this.player.getWorld().broadcastPacket(packet);
default void broadcastPacketToWorld(BasePacket packet) {
this.getPlayer().getWorld().broadcastPacket(packet);
}
/**
* Set the currently equipped avatar's health.
*
* @param health The health to set the avatar to.
*/
public void setHealth(float health) {
default void setHealth(float health) {
this.getCurrentAvatarEntity().setFightProperty(FightProperty.FIGHT_PROP_CUR_HP, health);
this.updateFightProperty(FightProperty.FIGHT_PROP_CUR_HP);
}
/**
* Revives the specified avatar.
*
* @param avatar The avatar to revive.
*/
public void reviveAvatar(Avatar avatar) {
default void reviveAvatar(Avatar avatar) {
this.broadcastPacketToWorld(new PacketAvatarLifeStateChangeNotify(avatar));
}
/**
* Teleports a player to a position.
* This will **not** transfer the player to another scene.
* Teleports a player to a position. This will **not** transfer the player to another scene.
*
* @param position The position to teleport the player to.
*/
public void teleport(Position position) {
this.player.getPosition().set(position);
this.player.sendPacket(new PacketPlayerEnterSceneNotify(this.player,
EnterType.ENTER_TYPE_JUMP, EnterReason.TransPoint,
this.player.getSceneId(), position
));
default void teleport(Position position) {
this.getPlayer().getPosition().set(position);
this.getPlayer()
.sendPacket(
new PacketPlayerEnterSceneNotify(
this.getPlayer(),
EnterType.ENTER_TYPE_JUMP,
EnterReason.TransPoint,
this.getPlayer().getSceneId(),
position));
}
/**
* Gets the currently selected avatar's max health.
*
* @return The max health as a float.
*/
public float getMaxHealth() {
default float getMaxHealth() {
return this.getCurrentAvatarEntity().getFightProperty(FightProperty.FIGHT_PROP_MAX_HP);
}
/**
* Gets the currently selected avatar in entity form.
*
* @return The avatar as an {@link EntityAvatar}.
*/
public EntityAvatar getCurrentAvatarEntity() {
return this.player.getTeamManager().getCurrentAvatarEntity();
default EntityAvatar getCurrentAvatarEntity() {
return this.getPlayer().getTeamManager().getCurrentAvatarEntity();
}
/**
* Gets the currently selected avatar.
*
* @return The avatar as an {@link Avatar}.
*/
public Avatar getCurrentAvatar() {
default Avatar getCurrentAvatar() {
return this.getCurrentAvatarEntity().getAvatar();
}
}

54
src/main/java/emu/grasscutter/plugin/api/ServerHook.java → src/main/java/emu/grasscutter/plugin/api/ServerHelper.java
View File

@@ -10,39 +10,46 @@ import emu.grasscutter.game.player.Player;
import emu.grasscutter.server.game.GameServer;
import emu.grasscutter.server.http.HttpServer;
import emu.grasscutter.server.http.Router;
import emu.grasscutter.server.scheduler.ServerTaskScheduler;
import java.util.ArrayList;
import java.util.List;
import java.util.stream.Stream;
/**
* Hooks into the {@link GameServer} class, adding convenient ways to do certain things.
*/
public final class ServerHook {
private static ServerHook instance;
/** Hooks into the {@link GameServer} class, adding convenient ways to do certain things. */
public final class ServerHelper {
private static ServerHelper instance;
private final GameServer gameServer;
private final HttpServer httpServer;
/**
* Gets the server hook instance.
* @return A {@link ServerHook} singleton.
*/
public static ServerHook getInstance() {
return instance;
}
/**
* Hooks into a server.
*
* @param gameServer The game server to hook into.
* @param httpServer The HTTP server to hook into.
*/
public ServerHook(GameServer gameServer, HttpServer httpServer) {
public ServerHelper(GameServer gameServer, HttpServer httpServer) {
this.gameServer = gameServer;
this.httpServer = httpServer;
instance = this;
}
/**
* Gets the server hook instance.
*
* @return A {@link ServerHelper} singleton.
*/
public static ServerHelper getInstance() {
return instance;
}
/**
* @return The server's current run mode.
*/
public Grasscutter.ServerRunMode getRunMode() {
return Grasscutter.getRunMode();
}
/**
* @return The game server.
*/
@@ -59,15 +66,16 @@ public final class ServerHook {
/**
* Gets all online players.
*
* @return Players connected to the server.
*/
@Deprecated(forRemoval = true)
public List<Player> getOnlinePlayers() {
return new ArrayList<>(this.gameServer.getPlayers().values());
}
/**
* Gets all online players.
*
* @return Players connected to the server.
*/
public Stream<Player> getOnlinePlayersStream() {
@@ -76,6 +84,7 @@ public final class ServerHook {
/**
* Registers a command to the {@link emu.grasscutter.command.CommandMap}.
*
* @param handler The command handler.
*/
public void registerCommand(CommandHandler handler) {
@@ -88,6 +97,7 @@ public final class ServerHook {
/**
* Adds a router using an instance of a class.
*
* @param router A router instance.
*/
public void addRouter(Router router) {
@@ -96,6 +106,7 @@ public final class ServerHook {
/**
* Adds a router using a class.
*
* @param router The class of the router.
*/
public void addRouter(Class<? extends Router> router) {
@@ -104,6 +115,7 @@ public final class ServerHook {
/**
* Sets the server's authentication system.
*
* @param authSystem An instance of the authentication system.
*/
public void setAuthSystem(AuthenticationSystem authSystem) {
@@ -112,9 +124,19 @@ public final class ServerHook {
/**
* Sets the server's permission handler.
*
* @param permHandler An instance of the permission handler.
*/
public void setPermissionHandler(PermissionHandler permHandler) {
Grasscutter.setPermissionHandler(permHandler);
}
/**
* @return The server's task scheduler.
*/
public ServerTaskScheduler getScheduler() {
if (this.getGameServer() == null) return null;
return this.getGameServer().getScheduler();
}
}