Setup
After installing the plugin, files will be generated in the plugins folder

Files/Folders

/settings.yml
/menus/
/lang/en_US.yml
/items.yml
Plugin's main configuration file.
Plugin's default menu loader folder
You can edit most of the plugin's messages in the language file
Storage for items created with the /trmenu itemRepo command

Setup

  • The settings.yml file is the main configuration file of the plugin.
  • The plugin will detect changes automatically and reload the file.
settings.yml
1
#
2
# Configuration
3
#
4
Options:
5
# Whether the debug mode should be enabled or not (more information will be sent to the console)
6
Debug: false
7
# Language of the plugin
8
# Available: zh_CN, zh_TW, en_US, fr_FR, th_TH, es_MX
9
Locale: en_US
10
# Whether to hide the Logo of the plugin in the console on startup
11
Hide-Logo: false
12
# When enabled TrMenu will get the player heads datas from Mojang's API
13
# [RECOMMENDED] If disabled, it will get them with https://github.com/Electroid/mojang-api
14
Skull-Mojang-API: false
15
16
#
17
# Get menus from a path leading to a folder or directly a menu
18
# Supports ItemRepo files to get pre-made items for your menus
19
#
20
Load-Menu-Files:
21
- 'plugins/CustomMenusFolder'
22
23
#
24
# Actions Configuration
25
#
26
Actions:
27
# Customize the words used to cancel an input catcher, supports regex
28
Catcher-Cancel-Words:
29
- '(?i)cancel|quit|exit|end|stop'
30
31
#
32
# Menu Items Configuration
33
#
34
Item:
35
# Default color for items' names
36
Default-Color-Name: '&7'
37
# Default color for items' lores
38
Default-Color-Lore: '&7'
39
40
#
41
# Actions Shortcuts Configuration
42
#
43
Shortcuts:
44
Offhand: 'open: Example'
45
Sneaking-Offhand:
46
- condition: 'hasPerm.trmenu.shortcut'
47
execute: 'open: Example'
48
Right-Click-Player: []
49
Sneaking-Right-Click-Player: []
50
PlayerInventory-Border-Left: []
51
PlayerInventory-Border-Right: []
52
PlayerInventory-Border-Middle: []
53
54
#
55
# Register commands with actions and arguments
56
# Supports tab-completition !
57
# (WARNING: A server restart is required to add, change or remove commands)
58
#
59
RegisterCommands:
60
# Command name
61
openMenus:
62
# Command Aliases
63
aliases: []
64
# Required permission
65
permission: null
66
# Actions executed without any arguments
67
execute:
68
- 'tell: &7Argument `example` Required!'
69
# Arguments with their actions
70
arguments:
71
example: 'open: example'
72
73
#
74
# When enabled, TrMenu will ignore cancelled events monitored by some plugins
75
# If you encouter compatibilities issues, try to toggle the option.
76
#
77
Events-Ignore-Cancelled:
78
PlayerCommandPreprocessEvent: true
79
InventoryOpenEvent: true
80
InventoryClickEvent: true
Copied!
Last modified 1yr ago
Copy link