GameMenu
一个类似 Hypixel Skyblock “Skyblock 菜单”的简易 Minecraft 服务器菜单插件。
完全可自定义,你可以通过编辑 config.yml 来自定义此插件。
目录
简介
GameMenu 是一款轻量级且用户友好的插件,专为 Minecraft 服务器设计。它为玩家提供可定制的菜单界面,方便玩家导航并访问服务器功能和命令。
功能
- 易于安装和配置。
- 可自定义菜单项和命令。
- [暂不可用] [付费] 支持多页菜单。
- 用户友好的界面。
- 轻量且高效。
安装
要安装 GameMenu 插件,请按照以下步骤操作:
-
下载插件:从此处、此处、此处或此处下载最新版本的 GameMenu 插件。
-
将插件添加到你的服务器:
- 将下载的 JAR 文件放入 Minecraft 服务器的
plugins 目录中。
[注意 - 此插件适用于 Spigot 和 Paper 服务器(也可能适用于其他服务器)]
-
启动服务器:只需启动你的 Minecraft 服务器即可加载插件。
-
验证安装:服务器启动后,通过在服务器控制台或游戏中运行 /plugins 命令来验证插件是否已加载。你应该在已加载的插件列表中看到 GameMenu。
配置
GameMenu 插件附带一个默认配置文件,你可以根据喜好对其进行自定义。要配置该插件:
- 进入
plugins/GameMenu 目录。
- 使用文本编辑器打开
config.yml 文件。
- 修改配置选项以满足你的需求。以下是默认配置:
#
# AUTHOR: Loghot (ItzLoghotXD)
# WIKI: https://github.com/ItzLoghotXD/GameMenu/wiki
# Copyright (c) ItzLoghotXD 2024-2024. All rights reserved.
#--------
# SERVER MENU ITEM
# 用于服务器菜单的自定义物品,
# 该物品位于玩家的快捷栏中
#--------
# SERVER MENU/GUI
# 当玩家执行 'gm menu' 命令时
# 打开的默认 GUI
#--------
# BUILT IN PLUGIN PLACEHOLDERS
# %player% - 返回玩家名称
# %online% - 返回在线玩家数量
# %online_max% - 返回最大玩家槽位数量
# *** 使用 PlaceholderAPI 获取更多内容 ***
# (https://hangar.papermc.io/HelpChat/PlaceholderAPI)
#--------
# BUILT-IN FEATURES
# 你可以使用 Minecraft 颜色代码
# 例如 '&a' 表示绿色,你可以在这里找到所有
# 代码 https://www.digminecraft.com/lists/color_list_pc.php
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
# | SERVER MENU ITEM SETTINGS |
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
server_menu_item:
material: NETHER_STAR # 用于此自定义物品的材质。(你可以在这里找到所有物品名称
# https://raw.githubusercontent.com/ItzLoghotXD/GameMenu/main/Materials.txt)
display_name: '&aServer Menu &7(Right Click)' # 此物品的显示名称
lore: # 此物品的描述文本
- '&7这将打开一个 GUI。'
- '&7你可以在那里看到物品'
- '&7并与它们交互!'
- '&7请在 config.yml 中编辑此项'
- ''
- '&e点击以打开'
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
# | SERVER MENU/GUI SETTINGS |
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
menu:
slots: 9 # GUI 中的总槽位数(如果你输入的数字不能被 9 整除
# 它将自动调整。最小有效数字为 9,最大为 54)
title: '&6Server Menu' # 此菜单的标题
items: # 你可以在这里设置将在菜单中显示的物品
# 一些示例物品
Report_Island_Name:
material: DIAMOND_BLOCK # 此物品在菜单中显示的材质
slot: 0 # 物品所在的槽位编号(从索引 0 开始)
amount: 1 # 每个槽位中的物品数量
glow: false # 物品是否发光
display_name: '&aDIAMONDS' # 此物品的显示名称
lore: # 此物品的描述文本
- '&7给你一些钻石!'
- '&7这只是一个示例'
- '&7请在配置中更改此项'
- ''
- '&e点击以获取!'
commands: # 当玩家右键/左键单击此物品时将执行的命令列表
# (内置命令 'CLOSE' 将关闭菜单,如果在任何命令前加上 'CONSOLE: '
# 则将以控制台身份执行该命令,否则以玩家身份执行)
- 'CONSOLE: give %player% diamond'
Crafting_Table:
material: CRAFTING_TABLE
slot: 4
amount: 1
glow: true
display_name: '&aCrafting Table'
lore:
- '&7打开合成网格。'
- ''
- '&7(实际上不会打开'
- '&7合成网格,仅作'
- '&7示例)请在配置中编辑'
- ''
- '&e点击以打开!'
commands:
- 'CONSOLE: say edit the config.yml file in the plugin/GameMenu folder'
- 'CONSOLE: say Visit me at paper hangar: https://hangar.papermc.io/ItzLoghotXD/GameMenu'
- 'CONSOLE: say Visit me at modrinth: https://modrinth.com/plugin/game-menu'
- 'CONSOLE: say Visit me at spigot: https://www.spigotmc.org/resources/gamemenu.122426'
- 'CONSOLE: say or found any issue then report it here: https://github.com/ItzLoghotXD/GameMenu/issues'
CLOSE:
material: BARRIER
slot: 8
display_name: '&4Close'
commands:
- 'CLOSE'
保存更改并通过在控制台中输入 /gamemenu reload 重新加载插件,以应用新配置。
使用方法
安装并配置好 GameMenu 插件后,所有玩家都可以通过在游戏内执行命令 /gamemenu menu,或在手持自定义物品 server_menu_item 时右键点击来使用菜单。这将打开带有已配置项的服务端菜单。
命令
GameMenu 插件提供以下命令:
/gamemenu - 默认命令。
- 别名 -
/gm
- 用法 -
/gamemenu <子命令>
/gamemenu help - 显示所有命令的用法。
gamemenu menu - 打开 主菜单。
gamemenu reload - 重新加载插件
权限
GameMenu 插件使用以下权限:
gamemenu.command.gm - 允许玩家使用默认命令。
gamemenu.command.help - 允许玩家使用 help 子命令。
gamemenu.command.menu - 允许玩家打开“主菜单”(Main menu)。
gamemenu.command.reload - 允许玩家重新加载插件。
贡献指南
欢迎为 GameMenu 插件做出贡献!如果您希望参与贡献,请按照以下步骤操作:
- Fork 该仓库。
- 为您的功能特性或错误修复创建一个新的分支。
- 进行修改,并使用描述性的提交信息提交更改。
- 将您的更改推送到您 Fork 的仓库中。
- 向主仓库创建拉取请求(Pull Request)。
请确保您的代码符合项目的编码规范,并包含适当的测试。
许可证
本项目采用 MIT 许可证授权。有关更多信息,请参阅 LICENSE 文件。
GameMenu
A simple Minecraft Server Menu plugin like Hypixel's Skyblock's "Skyblock Menu".
Fully customizable, you can customize this plugin by editing config.yml
Table of Contents
Introduction
GameMenu is a lightweight and user-friendly plugin designed for Minecraft servers. It provides a customizable menu interface for server players, allowing easy navigation and access to server features and commands.
Features
- Easy to install and configure.
- Customizable menu items and commands.
- [NOT AVAILABLE YET] [PREMIUM] Supports multiple menu pages.
- User-friendly interface.
- Lightweight and efficient.
Installation
To install the GameMenu plugin, follow these steps:
-
Download the plugin: Download the latest version of the GameMenu plugin from here or here or here or maybe from here.
-
Add the plugin to your server:
- Place the downloaded JAR file into the
plugins directory of your Minecraft server.
[Note - This plugin will work on both spigot and paper server (may work on other also)]
-
Start the server: Simply Start your Minecraft server to load the plugin.
-
Verify installation: Once the server is started, verify that the plugin is loaded by running the command /plugins in the server console or in-game. You should see GameMenu listed among the loaded plugins.
Configuration
The GameMenu plugin comes with a default configuration file that can be customized to your liking. To configure the plugin:
- Navigate to the
plugins/GameMenu directory.
- Open the
config.yml file in a text editor.
- Modify the configuration options to suit your needs. Below is the default configuration:
#
# AUTHOR: Loghot (ItzLoghotXD)
# WIKI: https://github.com/ItzLoghotXD/GameMenu/wiki
# Copyright (c) ItzLoghotXD 2024-2024. All rights reserved.
#--------
# SERVER MENU ITEM
# The custom item which is used for
# server menu which is present in
# player's hotbar
#--------
# SERVER MENU/GUI
# The default gui which is opens when
# player execute 'gm menu' command
#--------
# BUILT IN PLUGIN PLACEHOLDERS
# %player% - Returns player name
# %online% - Returns number of players online
# %online_max% - Returns number of max player slots
# *** USE PLACEHOLDERAPI TO GET MORE ***
# (https://hangar.papermc.io/HelpChat/PlaceholderAPI)
#--------
# BUILT-IN FEATURES
# You can use minecraft color codes
# like '&a' for green you can find all
# code here https://www.digminecraft.com/lists/color_list_pc.php
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
# | SERVER MENU ITEM SETTINGS |
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
server_menu_item:
material: NETHER_STAR # The material which is use for this custom item. (you can find all item names here
# https://raw.githubusercontent.com/ItzLoghotXD/GameMenu/main/Materials.txt)
display_name: '&aServer Menu &7(Right Click)' # The display name of this item
lore: # Lore(s) of this item
- '&7This will open a GUI.'
- '&7You can see items there'
- '&7and interact with them!'
- '&7edit this in config.yml'
- ''
- '&eClick to open'
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
# | SERVER MENU/GUI SETTINGS |
# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~#
menu:
slots: 9 # Total number of slots in the gui (if you enter any number which is not divisible by 9
# it will auto adjust it. minimum valid number is 9 and maximum is 54)
title: '&6Server Menu' # The title of this menu
items: # You can set items here which will be in the menu
# Some example items
Report_Island_Name:
material: DIAMOND_BLOCK # The material which will be displayed in the menu for this item
slot: 0 # The number of slot in which the item will be (starts from index 0)
amount: 1 # The Amount of items in a slot
glow: false # Whether the item glow or not
display_name: '&aDIAMONDS' # The display name of this item
lore: # Lore(s) of this item
- '&7Give you some Diamonds!'
- '&7This is just for example'
- '&7change this in config'
- ''
- '&eClick to get!'
commands: # The list of commands which will be executed when the player will right/left click on it
# (It has a built-in command 'CLOSE' which will close the menu and if you put 'CONSOLE: ' in before
# any command it will execute it as console else player)
- 'CONSOLE: give %player% diamond'
Crafting_Table:
material: CRAFTING_TABLE
slot: 4
amount: 1
glow: true
display_name: '&aCrafting Table'
lore:
- '&7Opens the Crafting Grid.'
- ''
- '&7(Will not actually open a'
- '&7crafting grid, just for'
- '&7example) edit in config'
- ''
- '&eClick to open!'
commands:
- 'CONSOLE: say edit the config.yml file in the plugin/GameMenu folder'
- 'CONSOLE: say Visit me at paper hangar: https://hangar.papermc.io/ItzLoghotXD/GameMenu'
- 'CONSOLE: say Visit me at modrinth: https://modrinth.com/plugin/game-menu'
- 'CONSOLE: say Visit me at spigot: https://www.spigotmc.org/resources/gamemenu.122426'
- 'CONSOLE: say or found any issue then report it here: https://github.com/ItzLoghotXD/GameMenu/issues'
CLOSE:
material: BARRIER
slot: 8
display_name: '&4Close'
commands:
- 'CLOSE'
Save the changes and reload the plugin by typing /gamemenu reload in the console to apply the new configuration.
Usage
Once the GameMenu plugin is installed and configured, all players can use the menu by executing the command /gamemenu menu in-game or by right-clicking when they are holding the custom server_menu_item. This will open the server menu with the configured items.
Commands
The GameMenu plugin provides the following commands:
/gamemenu - The default command.
- aliases -
/gm
- usage -
/gamemenu <subcommand>
/gamemenu help - Shows the usage of every command.
gamemenu menu - Opens the Main menu.
gamemenu reload - Reloads the plugin
Permissions
The GameMenu plugin uses the following permissions:
gamemenu.command.gm - Allows a player to use the default command.
gamemenu.command.help - Allows a player to use the help subcommand.
gamemenu.command.menu - Allows a player to open the Main menu
gamemenu.command.reload - Allows a player to reload the plugin.
Contributing
Contributions to the GameMenu plugin are welcome! If you would like to contribute, please follow these steps:
- Fork the repository.
- Create a new branch for your feature or bug fix.
- Make your changes and commit them with descriptive messages.
- Push your changes to your forked repository.
- Create a pull request to the main repository.
Please ensure that your code follows the project's coding standards and includes appropriate tests.
License
This project is licensed under the MIT License. See the LICENSE file for more information.
评论 0
登录后参与评分
还没有评论,来抢沙发吧