mirror of
https://github.com/GeyserMC/Geyser.git
synced 2024-08-14 23:57:35 +00:00
* This makes `geyser reload` work the same across all platforms. For example, it ensures that we reload the config to the greatest extent possible (with the exception of compression/injection settings). Additionally, this clears up issues where Extensions were previously disabled during reloading - instead, the new Pre and Post reload events allow extensions to reload whatever necessary on their own.
193 lines
6 KiB
Java
193 lines
6 KiB
Java
/*
|
|
* Copyright (c) 2019-2022 GeyserMC. http://geysermc.org
|
|
*
|
|
* 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.
|
|
*
|
|
* @author GeyserMC
|
|
* @link https://github.com/GeyserMC/Geyser
|
|
*/
|
|
|
|
package org.geysermc.geyser;
|
|
|
|
import org.checkerframework.checker.nullness.qual.NonNull;
|
|
import org.checkerframework.checker.nullness.qual.Nullable;
|
|
import org.geysermc.geyser.command.GeyserCommandManager;
|
|
import org.geysermc.geyser.configuration.GeyserConfiguration;
|
|
import org.geysermc.geyser.dump.BootstrapDumpInfo;
|
|
import org.geysermc.geyser.level.GeyserWorldManager;
|
|
import org.geysermc.geyser.level.WorldManager;
|
|
import org.geysermc.geyser.ping.IGeyserPingPassthrough;
|
|
|
|
import java.io.InputStream;
|
|
import java.net.SocketAddress;
|
|
import java.nio.file.Path;
|
|
import java.nio.file.Paths;
|
|
|
|
public interface GeyserBootstrap {
|
|
|
|
GeyserWorldManager DEFAULT_CHUNK_MANAGER = new GeyserWorldManager();
|
|
|
|
/**
|
|
* Called when the GeyserBootstrap is initialized.
|
|
* This will only be called once, when Geyser is loading. Calling this must
|
|
* happen before {@link #onGeyserEnable()}, since this "sets up" Geyser.
|
|
*/
|
|
void onGeyserInitialize();
|
|
|
|
/**
|
|
* Called when the GeyserBootstrap is enabled/reloaded.
|
|
* This starts Geyser, after which, Geyser is in a player-accepting state.
|
|
*/
|
|
void onGeyserEnable();
|
|
|
|
/**
|
|
* Called when the GeyserBootstrap is disabled - either before a reload,
|
|
* of before fully shutting down.
|
|
*/
|
|
void onGeyserDisable();
|
|
|
|
/**
|
|
* Called when the GeyserBootstrap is shutting down.
|
|
*/
|
|
void onGeyserShutdown();
|
|
|
|
/**
|
|
* Returns the current GeyserConfiguration
|
|
*
|
|
* @return The current GeyserConfiguration
|
|
*/
|
|
GeyserConfiguration getGeyserConfig();
|
|
|
|
/**
|
|
* Returns the current GeyserLogger
|
|
*
|
|
* @return The current GeyserLogger
|
|
*/
|
|
GeyserLogger getGeyserLogger();
|
|
|
|
/**
|
|
* Returns the current CommandManager
|
|
*
|
|
* @return The current CommandManager
|
|
*/
|
|
GeyserCommandManager getGeyserCommandManager();
|
|
|
|
/**
|
|
* Returns the current PingPassthrough manager
|
|
*
|
|
* @return The current PingPassthrough manager
|
|
*/
|
|
@Nullable
|
|
IGeyserPingPassthrough getGeyserPingPassthrough();
|
|
|
|
/**
|
|
* Returns the current WorldManager
|
|
*
|
|
* @return the current WorldManager
|
|
*/
|
|
default WorldManager getWorldManager() {
|
|
return DEFAULT_CHUNK_MANAGER;
|
|
}
|
|
|
|
/**
|
|
* Return the data folder where files get stored
|
|
*
|
|
* @return Path location of data folder
|
|
*/
|
|
Path getConfigFolder();
|
|
|
|
/**
|
|
* @return the folder where user tokens are saved. This should always point to the location of the config.
|
|
*/
|
|
default Path getSavedUserLoginsFolder() {
|
|
return getConfigFolder();
|
|
}
|
|
|
|
/**
|
|
* Information used for the bootstrap section of the debug dump
|
|
*
|
|
* @return The info about the bootstrap
|
|
*/
|
|
BootstrapDumpInfo getDumpInfo();
|
|
|
|
/**
|
|
* Returns the Minecraft version currently being used on the server. This should be only be implemented on platforms
|
|
* that have direct server access - platforms such as proxies always have to be on their latest version to support
|
|
* the newest Minecraft version, but older servers can use ViaVersion to enable newer versions to join.
|
|
* <br>
|
|
* If used, this should not be null before {@link GeyserImpl} initialization.
|
|
*
|
|
* @return the Minecraft version being used on the server, or <code>null</code> if not applicable
|
|
*/
|
|
@Nullable
|
|
default String getMinecraftServerVersion() {
|
|
return null;
|
|
}
|
|
|
|
@Nullable
|
|
default SocketAddress getSocketAddress() {
|
|
return null;
|
|
}
|
|
|
|
default Path getLogsPath() {
|
|
return Paths.get("logs/latest.log");
|
|
}
|
|
|
|
/**
|
|
* Get an InputStream for the given resource path.
|
|
* Overridden on platforms that have different class loader properties.
|
|
*
|
|
* @param resource Resource to get
|
|
* @return InputStream of the given resource, or null if not found
|
|
*/
|
|
default @Nullable InputStream getResourceOrNull(String resource) {
|
|
return GeyserBootstrap.class.getClassLoader().getResourceAsStream(resource);
|
|
}
|
|
|
|
/**
|
|
* Get an InputStream for the given resource path, throws AssertionError if resource is not found.
|
|
*
|
|
* @param resource Resource to get
|
|
* @return InputStream of the given resource
|
|
*/
|
|
default @NonNull InputStream getResourceOrThrow(@NonNull String resource) {
|
|
InputStream stream = getResourceOrNull(resource);
|
|
if (stream == null) {
|
|
throw new AssertionError("Unable to find resource: " + resource);
|
|
}
|
|
return stream;
|
|
}
|
|
|
|
/**
|
|
* @return the bind address being used by the Java server.
|
|
*/
|
|
@NonNull
|
|
String getServerBindAddress();
|
|
|
|
/**
|
|
* @return the listening port being used by the Java server. -1 if can't be found
|
|
*/
|
|
int getServerPort();
|
|
|
|
/**
|
|
* Tests if Floodgate is installed, loads the Floodgate key if so, and returns the result of Floodgate installed.
|
|
*/
|
|
boolean testFloodgatePluginPresent();
|
|
}
|