2020-04-29 20:01:53 +00:00
|
|
|
/*
|
2021-01-01 15:10:36 +00:00
|
|
|
* Copyright (c) 2019-2021 GeyserMC. http://geysermc.org
|
2020-04-29 20:01:53 +00:00
|
|
|
*
|
2020-07-30 20:10:15 +00:00
|
|
|
* 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:
|
2020-04-29 20:01:53 +00:00
|
|
|
*
|
2020-07-30 20:10:15 +00:00
|
|
|
* The above copyright notice and this permission notice shall be included in
|
|
|
|
* all copies or substantial portions of the Software.
|
2020-04-29 20:01:53 +00:00
|
|
|
*
|
2020-07-30 20:10:15 +00:00
|
|
|
* 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.
|
2020-04-29 20:01:53 +00:00
|
|
|
*
|
2020-07-30 20:10:15 +00:00
|
|
|
* @author GeyserMC
|
|
|
|
* @link https://github.com/GeyserMC/Geyser
|
2020-04-29 20:01:53 +00:00
|
|
|
*/
|
|
|
|
|
2021-11-20 23:29:46 +00:00
|
|
|
package org.geysermc.geyser;
|
2021-11-20 21:34:30 +00:00
|
|
|
|
|
|
|
import org.geysermc.geyser.GeyserImpl;
|
|
|
|
import org.geysermc.geyser.configuration.GeyserConfiguration;
|
2021-11-21 18:36:42 +00:00
|
|
|
import org.geysermc.geyser.GeyserLogger;
|
2021-11-20 21:34:30 +00:00
|
|
|
import org.geysermc.geyser.command.CommandManager;
|
|
|
|
import org.geysermc.geyser.dump.BootstrapDumpInfo;
|
2021-11-20 23:29:46 +00:00
|
|
|
import org.geysermc.geyser.level.GeyserWorldManager;
|
|
|
|
import org.geysermc.geyser.level.WorldManager;
|
2021-11-20 21:34:30 +00:00
|
|
|
import org.geysermc.geyser.ping.IGeyserPingPassthrough;
|
2020-04-29 20:01:53 +00:00
|
|
|
|
2021-02-04 00:54:35 +00:00
|
|
|
import javax.annotation.Nullable;
|
2021-07-31 16:52:49 +00:00
|
|
|
import java.net.SocketAddress;
|
2020-06-20 17:54:40 +00:00
|
|
|
import java.nio.file.Path;
|
2021-08-24 19:11:38 +00:00
|
|
|
import java.nio.file.Paths;
|
2020-06-20 17:54:40 +00:00
|
|
|
|
2020-04-29 20:01:53 +00:00
|
|
|
public interface GeyserBootstrap {
|
|
|
|
|
2020-08-08 22:41:12 +00:00
|
|
|
GeyserWorldManager DEFAULT_CHUNK_MANAGER = new GeyserWorldManager();
|
2020-04-29 20:01:53 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Called when the GeyserBootstrap is enabled
|
|
|
|
*/
|
|
|
|
void onEnable();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Called when the GeyserBootstrap is disabled
|
|
|
|
*/
|
|
|
|
void onDisable();
|
|
|
|
|
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
*/
|
|
|
|
CommandManager getGeyserCommandManager();
|
|
|
|
|
2020-05-23 21:50:04 +00:00
|
|
|
/**
|
|
|
|
* Returns the current PingPassthrough manager
|
|
|
|
*
|
|
|
|
* @return The current PingPassthrough manager
|
|
|
|
*/
|
|
|
|
IGeyserPingPassthrough getGeyserPingPassthrough();
|
|
|
|
|
2020-04-29 20:01:53 +00:00
|
|
|
/**
|
|
|
|
* Returns the current WorldManager
|
|
|
|
*
|
|
|
|
* @return the current WorldManager
|
|
|
|
*/
|
|
|
|
default WorldManager getWorldManager() {
|
|
|
|
return DEFAULT_CHUNK_MANAGER;
|
|
|
|
}
|
2020-06-20 17:54:40 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Return the data folder where files get stored
|
|
|
|
*
|
|
|
|
* @return Path location of data folder
|
|
|
|
*/
|
|
|
|
Path getConfigFolder();
|
2020-06-27 15:36:48 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Information used for the bootstrap section of the debug dump
|
|
|
|
*
|
|
|
|
* @return The info about the bootstrap
|
|
|
|
*/
|
|
|
|
BootstrapDumpInfo getDumpInfo();
|
2021-02-04 00:54:35 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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>
|
2021-11-20 21:34:30 +00:00
|
|
|
* If used, this should not be null before {@link GeyserImpl} initialization.
|
2021-02-04 00:54:35 +00:00
|
|
|
*
|
|
|
|
* @return the Minecraft version being used on the server, or <code>null</code> if not applicable
|
|
|
|
*/
|
|
|
|
@Nullable
|
|
|
|
default String getMinecraftServerVersion() {
|
|
|
|
return null;
|
|
|
|
}
|
2021-07-31 16:52:49 +00:00
|
|
|
|
|
|
|
@Nullable
|
|
|
|
default SocketAddress getSocketAddress() {
|
|
|
|
return null;
|
|
|
|
}
|
2021-08-24 19:11:38 +00:00
|
|
|
|
|
|
|
default Path getLogsPath() {
|
|
|
|
return Paths.get("logs/latest.log");
|
|
|
|
}
|
2020-04-29 20:01:53 +00:00
|
|
|
}
|