Setup

How to setup GameCore

Config Variables

  • global-chat: Toggle whether chat should be viewed across the server or stay local within a game.

  • spectator-chat: Toggle spectators chatting. Doing this does also block staff who chose to use the command /gamecore bypass

  • global-chat-format: How the chat should be formatted. Accepts the tags: '%game%' (game name), '%username%' (player name), and '%message%' (player's message).

  • default-world: The default world set in the server's server.properties file

  • default-game: The game that GameCore will send you to when you log in. This should be the lobby but can be changed if needed.

  • use-sql-database: Should GameCore use an SQL database? SQL database is required for friends and score functionality.

  • friends-enabled: Should the friend system be enabled?

  • friend-cache-threshold: How many friend data modifications should be made before the SQL database is accessed. (This should be above zero to prevent constant pinging to the database)

  • max-friends: The max number of friends a player can have. (The higher the limit the more of a performance hit the server/network could have)

  • host: The SQL server IP.

  • port: The port of the SQL server.

  • database: The database to save the data tables to.

  • username: The username to log into the database.

  • password: The password to log into the database.


Troubleshooting

  • Make sure you format your configs correctly. If you have any doubts about the config, remove it from the config folder and let a new one generate. Once you got a fresh config you can then compare your configs.

How to setup the Lobby

Main Config Variables

  • minimumlevel: The lowest Y-level in the world before the player gets teleported back to spawn. This can be adjusted for lobbies that float in the air.

  • spawn-location: The location of the lobby's spawn.


Menu Configs

Inventory Config Items

Items are named as 'slot-#' where # can be any number between 0 and 53

  • item: The item to put in the hot-bar.

  • name: The name of the item. Color codes are supported.

  • enchanted: Will a glow be put on the item?

  • function: The function of the button. Not all functions can be used with every config so read more to figure out which one you can use.

  • data: The data for the button. The type of data and how much data used depends on the function so read more for more information.

Functions And Data

function: can be one of the following functions: INFO, TELEPORT, GAME_LIST, GAME_MENU, PLAY_GAME, BACK

  • INFO: Displays text when clicked. Data required is a list of strings.

  • TELEPORT: Teleport player to a location. Data required is a formatted location string.

  • GAME_LIST: Open the game list menu. No data to be set.

  • GAME_MENU: Open a game menu. Data required is a game name as a string.

  • PLAY_GAME: Play a specific game. Data required is a game name as a string. (Accepts the flag '%game%' when navigating from a game menu.)

  • BACK: Go back a menu.

The Configs

Hotbar.yml

  • Accepts items for slots 0 to 8.

  • Allows button functions: INFO, TELEPORT, GAME_LIST, GAME_MENU, PLAY_GAME

Note that PLAY_GAME does not accept the flag %game% here as it is only available from the game menu.

GameListMenu.yml

  • Must define menu-size as a factor of 9.

  • Menu title can accept color codes.

  • Accepts items for all slots.

  • Allows button functions: INFO, TELEPORT, GAME_MENU, PLAY_GAME

Note that PLAY_GAME does not accept the flag %game% here as it is only available from the game menu.

GameMenu.yml

  • Must define menu-size as a factor of 9.

  • Menu title can accept color codes and the flag '%game%' (game name).

  • Accepts items for all slots.

  • Allows button functions: INFO, TELEPORT, GAME_MENU, PLAY_GAME, WORLD_MENU, MAP_MENU

Note that PLAY_GAME will accept the flag %game% here because the GameMenu is associated with a game.Note also that the functions WORLD_MENU and MAP_MENU don't accept any data.

MapListMenu.yml

  • Must define menu-size as a factor of 9.

  • Menu title can accept color codes and the flag '%game%' (game name).

  • map-item: The item displayed for each map.

  • map-name: The name on the map item. Accepts colors and the flag '%map%' (map name). It is highly recommended to include the flag as it will display what map the button represents.

  • map-lore: The lore for the item. Accepts color codes.

  • enchanted: Will a glow be put on the item?

WorldListMenu.yml

  • Must define menu-size as a factor of 9.

  • Menu title can accept color codes and the flag '%game%' (game name).

  • waiting-open-item: The item displayed for worlds that are waiting and open.

  • waiting-closed-item: The item displayed for worlds that are waiting and closed.

  • running-open-item: The item displayed for worlds that are running and open.

  • running-closed-item: The item displayed for worlds that are running and closed.

  • world-name: The name on the item. Accepts colors and the flags: '%map%' (map name), '%count%' (players in game), and '%max%' (max players that can be in game).

  • world-lore: The lore for the item. Accepts color codes and the flag '%status%' (the status of the game).

  • enchanted: Will a glow be put on the item?


Troubleshooting

  • The lobby runs on the default world on your server identified in the server.properties file. If you get an error joining the lobby, make sure the GameCore config has 'default-world' set to the same as the world name in server.properties.

  • Make sure you format your configs correctly. If you have any doubts about the config, remove it from the config folder and let a new one generate. Once you got a fresh config you can then compare your configs.

How to set up Spleef

Config Variables

  • local-chat-format: How the chat should be formatted within the the game. Accepts the tags: '%game%' (game name), '%username%' (player name), '%color%' (team color), and '%message%' (player's message).

  • snowballs: Should snowballs be enabled?

  • lava-instant-kill: Should lava instantly kill the player?

  • world-despawn-time: The length the game will stay before closing after no players are in the world.

  • game-countdown: The length of time before the game starts.

  • game-countdown-fast: The length of time before the game starts after the game is full.

  • grace-period: Period of time before the PVP starts.

Maps Configuration

  • map-count: how many maps that will be configured.

  • map-#: A map config where # is a number from 1 to the map count and represents all the settings for a map.

Map Config

  • name: The name of the map. Must be the same as the file name.

If you want to have a different map name, you must also change the name of the map file.

  • max-players: The max amount of players allowed in the map.

  • min-players: The minimum amount of players required for the game to start.

  • wait-room-spawn: The location of where players will spawn before the game starts.

  • game-spawn: The spawn location for when the game starts.


Troubleshooting

  • Make sure you format your configs correctly. If you have any doubts about the config, remove it from the config folder and let a new one generate. Once you got a fresh config you can then compare your configs.

How to set up Free For All

Config Variables

  • local-chat-format: How the chat should be formatted within the the game. Accepts the tags: '%game%' (game name), '%username%' (player name), '%color%' (team color), and '%message%' (player's message).

  • auto-tnt: Should TNT be primed when placed?

  • world-despawn-time: The length the game will stay before closing after no players are in the world.

  • game-countdown: The length of time before the game starts.

  • game-countdown-fast: The length of time before the game starts after the game is full.

  • grace-period: Period of time before the PVP starts.

Maps Configuration

  • map-count: how many maps that will be configured.

  • map-#: A map config where # is a number from 1 to the map count and represents all the settings for a map.

Map Config

  • respawn-region-count: How many respawn regions will be defined?

  • name: The name of the map. Must be the same as the file name.

If you want to have a different map name, you must also change the name of the map file.

  • max-players: The max amount of players allowed in the map.

  • min-players: The minimum amount of players required for the game to start.

  • main-spawn: The location of where players will spawn before the game starts.

  • respawn-region-#: A respawn region where # is a number from 1 to the respawn region count and defines two positions marking a region where players can spawn.

  • pos-1: The first location marking out the respawn region.

  • pos-2: The second location marking out the respawn region.


Troubleshooting

  • Make sure you format your configs correctly. If you have any doubts about the config, remove it from the config folder and let a new one generate. Once you got a fresh config you can then compare your configs.

How to set up Team Death Match

Config Variables

  • local-chat-format: How the chat should be formatted within the the game. Accepts the tags: '%game%' (game name), '%username%' (player name), '%color%' (team color), and '%message%' (player's message).

  • auto-tnt: Should TNT be primed when placed?

  • world-despawn-time: The length the game will stay before closing after no players are in the world.

  • game-countdown: The length of time before the game starts.

  • game-countdown-fast: The length of time before the game starts after the game is full.

Maps Configuration

  • map-count: how many maps that will be configured.

  • map-#: A map config where # is a number from 1 to the map count and represents all the settings for a map.

Map Config

  • respawn-region-count: How many respawn regions will be defined?

  • name: The name of the map. Must be the same as the file name.

If you want to have a different map name, you must also change the name of the map file.

  • max-players: The max amount of players allowed in the map.

  • min-players: The minimum amount of players required for the game to start.

  • main-spawn: The location of where players will spawn before the game starts.

  • team-1-spawn: The location of where team one will spawn.

  • team-2-spawn: The location of where team two will spawn.

  • team-1-color: The color of the team.

  • team-2-color: The color of the team.

Available colors for teams are: AQUA, BLACK, BLUE, DARK_AQUA, DARK_BLUE, DARK_GRAY, DARK_GREEN, DARK_PURPLE, DARK_RED, GOLD, GRAY, GREEN, LIGHT_PURPLE, RED, WHITE, YELLOW


Troubleshooting

  • Make sure you format your configs correctly. If you have any doubts about the config, remove it from the config folder and let a new one generate. Once you got a fresh config you can then compare your configs.

How to set up Capture The Flag

Config Variables

  • local-chat-format: How the chat should be formatted within the the game. Accepts the tags: '%game%' (game name), '%username%' (player name), '%color%' (team color), and '%message%' (player's message).

  • auto-tnt: Should TNT be primed when placed?

  • world-despawn-time: The length the game will stay before closing after no players are in the world.

  • game-countdown: The length of time before the game starts.

  • game-countdown-fast: The length of time before the game starts after the game is full.

Maps Configuration

  • map-count: how many maps that will be configured.

  • map-#: A map config where # is a number from 1 to the map count and represents all the settings for a map.

Map Config

  • respawn-region-count: How many respawn regions will be defined?

  • name: The name of the map. Must be the same as the file name.

If you want to have a different map name, you must also change the name of the map file.

  • max-players: The max amount of players allowed in the map.

  • min-players: The minimum amount of players required for the game to start.

  • required-flags: The amount of flags needed to be captured to win the game.

  • main-spawn: The location of where players will spawn before the game starts.

  • team-1-spawn: The location of where team one will spawn.

  • team-2-spawn: The location of where team two will spawn.

  • team-1-flag: The location of team one's flag. The block below this position is the flag's base that will be clicked on to capture another team's flag.

  • team-2-flag: The location of team two's flag. The block below this position is the flag's base that will be clicked on to capture another team's flag.

  • team-1-color: The color of the team.

  • team-2-color: The color of the team.

Available colors for teams are: AQUA, BLACK, BLUE, DARK_AQUA, DARK_BLUE, DARK_GRAY, DARK_GREEN, DARK_PURPLE, DARK_RED, GOLD, GRAY, GREEN, LIGHT_PURPLE, RED, WHITE, YELLOW


Troubleshooting

  • Make sure you format your configs correctly. If you have any doubts about the config, remove it from the config folder and let a new one generate. Once you got a fresh config you can then compare your configs.

How to set up Infected

Config Variables

  • local-chat-format: How the chat should be formatted within the the game. Accepts the tags: '%game%' (game name), '%username%' (player name), '%color%' (team color), and '%message%' (player's message).

  • auto-tnt: Should TNT be primed when placed?

  • world-despawn-time: The length the game will stay before closing after no players are in the world.

  • game-countdown: The length of time before the game starts.

  • game-countdown-fast: The length of time before the game starts after the game is full.

  • grace-period: Period of time before the PVP starts.

Maps Configuration

  • map-count: how many maps that will be configured.

  • map-#: A map config where # is a number from 1 to the map count and represents all the settings for a map.

Map Config

  • respawn-region-count: How many respawn regions will be defined?

  • name: The name of the map. Must be the same as the file name.

If you want to have a different map name, you must also change the name of the map file.

  • max-players: The max amount of players allowed in the map.

  • min-players: The minimum amount of players required for the game to start.

  • main-spawn: The location of where players will spawn before the game starts.

  • respawn-region-#: A respawn region where # is a number from 1 to the respawn region count and defines two positions marking a region where players can spawn.

  • pos-1: The first location marking out the respawn region.

  • pos-2: The second location marking out the respawn region.


Troubleshooting

  • Make sure you format your configs correctly. If you have any doubts about the config, remove it from the config folder and let a new one generate. Once you got a fresh config you can then compare your configs.