· 8 years ago · Mar 20, 2018, 08:12 AM
1# == Introduction ==
2# This file contains Skript's general options. To write scripts, create a new .sk file in the scripts folder or edit any existing one.
3#
4# Script files prefixed with a hyphen (-) will not be loaded, e.g. renaming 'plant with hoe.sk' to '-plant with hoe.sk' will disable the whole file.
5# This can e.g. be used to temporarily disable scripts and is also used for Skript's example scripts.
6# You can also use the command '/skript enable/disable <script>' to enable/disable a script which will automatically rename it.
7#
8# === !!! PLEASE NOTE !!! ===
9# This file, all scripts and other files ending in .sk are NOT .yml/YAML files, but very similar!
10# Please remember the following when editing files:
11# - To indent sections you can use spaces like in YAML, but tabs are also allowed. Just remember to stick to the one or the other for a section/trigger.
12# - '#' starts a comment like in YAML. If you don't want it to start a comment simply double it: '##' (You also have to double these in "quoted text")
13# - If you use special characters (§, äöü, éèà ôç, ñ, etc.) you have to encode the file in UTF-8.
14#
15
16
17
18# ==== General Options ====
19
20language: english
21# Which language to use. Currently english and german are included in the download, but custom languages can be created as well.
22# Please note that not everything can be translated yet, i.e. parts of Skript will still be english if you use another language.
23# If you want to translate Skript to your language please read the readme.txt located in the /lang/ folder in the jar
24# (open the jar as zip or rename it to Skript.zip to access it)
25
26
27check for new version: true
28# Whether Skript should check for whether a new version of Skript is available when the server starts.
29# If this is set to true Skript will announce a new version to all players with the "skript.admin" permission.
30# If set to false you can still check for a new version with '/skript update check'.
31# Please note that Skript will not detect beta releases even if you are running one as they are not necessarily stable.
32
33update check interval: 12 hours
34# If 'check for new version' is enabled, this sets how often to check for a new update.
35# A first check will always be made when the server starts, after that checks will be made in intervals set by this option.
36# Set this to 0 to disable repeated checks, in which case only one check will be made when the server starts.
37# Please note that this option is currently the only means of making Skript check for an update more than once,
38# as '/skript update check' does only display the results of the last check if a check has been made before.
39
40automatically download new version: false
41# Whether Skript should automatically download & install the newest version if one is available.
42# I suggest to disable this feature if your server restarts automatically as you likely won't be informed
43# of any incompatibilities of your scripts and the newest version of Skript.
44# If you disable this you can still use '/skript update download' to make Skript download the newest version.
45# If you're concerned about changes use '/skript update changes' for a full list of changes since your current version.
46
47
48enable effect commands: false
49effect command token: !
50# If 'enable effect commands' is set to true, chat messages starting with the 'effect command token' will be interpreted as effects and executed.
51# The token can be longer than a single character, but it should not start with '/' as that starts a command.
52# A player needs the permission "skript.effectcommands" to use such commands,
53# which does not default to OPs since these commands can do severe damage to the world or crash the server (see below).
54# Some example commands which can be used if this setting is enabled:
55# !heal player - heals the player (doesn't do anything if used from the console)
56# !repair tool - repairs the currently held item
57# !broadcast "<red>Please read the rules!" - if you want to get rid of the quotes you have to define a custom command
58# !set time to 6:00 - sets the time in the current world
59# The command can also be abused, so only give the permission to trusted players, like owners & co-owners:
60# !spawn 20 ender dragons - will destroy a large part of the world in a short time if no protection is present
61# !create explosion of force 10000 - likely crashes the server or at least hangs it up for a long time
62# !ban all players - as the effect implies
63
64allow ops to use effect commands: false
65# Whether server operators which do not have the permission "skript.effectcommands" should have access to effect commands.
66# This setting is mainly useful for servers that do not run any permissions plugin.
67
68
69use player UUIDs in variable names: false
70# Whether to use a player's UUID instead of their name in variables, e.g. {home.%player%} will look like
71# {home.e5240337-a4a2-39dd-8ed9-e5ce729a8522} instead of {home.njol}.
72# Please note that if this setting is changed old variables WILL NOT be renamed automatically.
73
74
75date format: default
76# The date format to be used when dates should be displayed.
77# This can be 'default' to use Java's default date format for the system's language.
78# The format is that of Java's SimpleDateFormat as defined here: http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html
79# some examples:
80# d/M/yyyy h:mm a => 15/7/2012 8:53 PM
81# dd.MM.yyyy, HH:mm => 16.03.2013, 09:33
82
83
84verbosity: normal
85# Determines how much info is logged.
86# Allowed values: low, normal, high, very high, debug
87# The highest you should go is very high, which prints quite a lot of useful information,
88# including how much time each trigger takes to execute.
89# Only use debug if you're programming an add-on for Skript, but even then you might usually not need it.
90
91
92plugin priority: high
93# Allowed values: lowest, low, normal, high, highest
94# Change this if you encounter problems with other plugins, e.g.:
95# - cancelled events: The event is cancelled by another plugin, but Skript handles the event nonetheless => increase priority
96# (e.g. WorldGuard cancels events if a player doesn't have permission for the given region,
97# and you made some 'place' triggers which should not bypass WorldGuard's protection)
98# - effects '(un)cancel event': Another plugin should/should not process the event, but does/does not => decrease priority
99# - effect 'drop': Another plugin doesn't process added drops => decrease priority
100# - effects 'remove ... from drops'/'clear drops': Drops added by other plugins are not removed => increase priority
101# Skript removes drops it shouldn't => decrease priority or specify which item types to remove
102
103
104log player commands: true
105# Whether Skript should log the usage of custom commands.
106# They will be logged as [INFORMATION] in this format: '<player>: /<command> <arguments>'
107
108
109number accuracy: 2
110# How many digits should be displayed after the dot at maximum when displaying numbers.
111# Zeroes will never be displayed at all, so this setting only applies to numbers that actually have a decimal part with one or more non-zero digits.
112# Money bypasses this setting and is displayed as configured in your economy plugin if you have one.
113
114
115maximum target block distance: 100
116# How far to search for a player's targeted block in blocks/meters.
117# Lower values improve performance, but might reduce the usability of your scripts.
118# This value is limited by the server (e.g. by 'view-distance' in the server.properties), but is guaranteed to work up to 100 meters.
119
120
121case sensitive: false
122# Whether Skript's functions should be case sensitive or not.
123# This e.g. applies to the effect 'replace' and the conditions 'contains' and 'is/is not'.
124# Variable names are case-insensitive irrespective of this setting.
125
126
127disable variable conflict warnings: false
128# Disables warnings of potential variable name conflicts if set to true.
129# I recommend to not touch this option, but if you do so you should at least set it back to false
130# whenever you create new scripts with new variables.
131
132
133
134# ==== Variables ====
135
136databases:
137 # Databases to store variables in. These can either be used as a simple one-server-storage
138 # where variables are written constantly but only read at server start,
139 # or as a connection between multiple servers by monitoring the database(s) for changes.
140 #
141 # You can define as many databases as you want, just make sure to choose a distinct name for each one, and don't forget to set all options correctly.
142 #
143 # To be able to use a database you'll need to download the plugin 'SQLibrary' from http://dev.bukkit.org/server-mods/sqlibrary/files/
144 # and install it in your server's plugin directory like other plugins.
145 #
146 # Please note that '/skript reload' will not reload this section, i.e. you'll have to restart Skript for changes to take effect.
147
148 # Each database definition must be in a separate section. You can choose any name for the sections, as long as it's not already used.
149 database 1:
150 # an example database to describe all possible options.
151
152 type: disabled
153 # The type of this database. Allowed values are 'CSV', 'SQLite', 'MySQL' and 'disabled'.
154 # CSV uses a text file to store the variables, while SQLite and MySQL use databases, and 'disabled' makes Skript ignore the database as if it wasn't defined at all.
155
156 pattern: .*
157 # Defines which variables to save in this database.
158 # This pattern uses Regex syntax, e.g. use 'db_.*' (without the quotes) to store all variables prefixed with 'db_' in this database,
159 # or use '.*' (the default value) to store all variables here (recommended for the last database in this list, as otherwise some variables might not be saved).
160 # Please note that variables are only stored in one database, and databases are checked from top to bottom,
161 # e.g. if a variable matches the topmost database's pattern it will be saved there and nowhere else.
162 # BTW: Patterns are checked in a separate thread, i.e. your server likely won't run slower when using complicated patterns.
163
164 monitor changes: false
165 monitor interval: 20 seconds
166 # If 'monitor changes' is set to true, variables will repeatedly be checked for updates in the database (in intervals set in 'monitor interval').
167 # ! Please note that you should set 'pattern', 'monitor changes' and 'monitor interval' to the same values on all servers that access the same database!
168
169 # == MySQL configuration ==
170 host: localhost # Where the database server is located at, e.g. 'example.com', 'localhost', or '192.168.1.100'
171 port: 3306 # 3306 is MySQL's default port, i.e. you likely won't need to change this value
172 user: root
173 password: pass
174 database: skript # The database to use. Skript will automatically create a table 'variables21' in this database if it doesn't exist
175 # (If the table exists but is defined differently that how Skript expects it to be you'll get errors and no variables will be saved and/or loaded)
176
177 # == SQLite/CSV configuration ==
178 file: ./plugins/Skript/variables.db
179 # Where to save the variables to. For a CSV file, the file extension '.csv' is recommended, but not required, but SQLite database files must end in '.db' (SQLibrary forces this).
180 # The file path can either be absolute (e.g. 'C:\whatever\...' [Windows] or '/usr/whatever/...' [Unix]), or relative to the server directory (e.g. './plugins/Skript/...').
181
182 backup interval: 2 hours
183 # Creates a backup of the file every so often. This can be useful if you ever want to revert variables to an older state.
184 # Variables are saved constantly no matter what is set here, thus a server crash will never make you loose any variables.
185 # Set this to 0 to disable this feature.
186
187
188 MySQL example:
189 # A MySQL database example, with options unrelated to MySQL removed.
190
191 type: disabled # change to line below to enable this database
192 # type: MySQL
193
194 pattern: synced_.* # this pattern will save all variables that start with 'synced_' in this MySQL database.
195
196 host: localhost
197 port: 3306
198 user: root
199 password: pass
200 database: skript
201
202 monitor changes: true
203 monitor interval: 20 seconds
204
205 SQLite example:
206 # An SQLite database example.
207
208 type: disabled # change to line below to enable this database
209 # type: SQLite
210
211 pattern: db_.* # this pattern will save all variables that start with 'db_' in this SQLite database.
212
213 file: ./plugins/Skript/variables.db
214 # SQLite databases must end in '.db'
215
216 backup interval: 0 # 0 = don't create backups
217 monitor changes: false
218 monitor interval: 20 seconds
219
220 default:
221 # The default "database" is a simple text file, with each variable on a separate line and the variable's name, type, and value separated by commas.
222 # This is the last database in this list to catch all variables that have not been saved anywhere else.
223 # You can modify this database freely, but make sure to know what you're doing if you don't want to loose any variables.
224
225 type: CSV
226
227 pattern: .*
228
229 file: ./plugins/Skript/variables.csv
230
231 backup interval: 2 hours
232
233 # PS: If you don't want some variables to be saved in any database (e.g. variables that contain an %entity% which usually despawn when the server is shut down)
234 # you can modify the last database's pattern to not match all variables, e.g. use '(?!x_).*' to match all variables that don't start with 'x_'.
235 # Be very cautious when doing this however as unsaved variables cannot be recovered after the server has been stopped.
236 # I recommend to use a single character to denote unsaved variables (similar to local variables' '_'), e.g. '-', in which case the last database's pattern should be '(?!-).*'.
237
238
239
240# ==== Settings that should not be changed ====
241
242version: ${project.version}
243# DO NOT CHANGE THIS VALUE MANUALLY!
244# This saves for which version of Skript this configuration was written for.
245# If it does not match the version of the .jar file then the config will be updated automatically.