Skip to content
Ntdi edited this page Dec 17, 2022 · 2 revisions

Using the Config in developement

The config.yml contains values the affect both the server and the developement.

If you need to reference something inside of the config, please use the ConfigUtils method,

public void example() {
    String permPerfix = ConfigUtils.PERMISSION_PREFIX;

    Bukkit.getLogger("You must have " + permPrefix + " In order to be cool!");
}

Note: Most of these values are not reactive, changing them will not update the config.yml

Set spawn

The only config value that contains a setting function is ConfigUtils.setSpawn();

The function takes a Location variable. All it does is update the spawn location in the config.yml You are able to change this manually if you want.

Config value's explanation

The default config contains these values:

theme:
  main: "&0&0&c&0&c&8"
  secondary: "&0&0&9&6&C&8"

permission-prefix: "nrcore."
no-permission: " &cYou are missing the permission: "

spawn:
  world: world
  x: 0
  y: 0
  z: 0
  yaw: 0.0
  pitch: 0.0

teleport:
  sound: ENTITY_ENDERMAN_TELEPORT
  delay: 5

help:
  - "I love helping people"
  - "Helping is &cwhat &fI do&l!"

# World Guard configs
world-guard:
  block-state-change: true

messaging:
  sent: "&3To &b%player% &f%msg%"
  from: "&3From &b%player% &f%msg%"

# SQL DB ONLY USE FOR DEVELOPERS USING API
sql:
  # Enable usage of a sql Database
  sql-enabled: false
  # The Url of the database, NOT INCLUDING HTTP:// or :// or HTTPS://
  sql-url: ""
  # SUPERUSER name of the database
  sql-user: ""
  # The SUPERUSER password for the database
  sql-password: ""

Most of these values should be self explanatory, but we will go over them anyway!

theme The general theme for the command and such, Uses hex code values.

permission-prefix The prefix that should be used for the commands, e.g. nrcore. The command framework handles most of that for you!

no-permission The permission that gets sent whenever a user executes a NR-Core command but doesn't have the permission to do so.

spawn The spawn of your server, this is mainly used for your own developement purposes but also used in the SpawnCommand.java

help The lines that are supplied when a user runs /help. This replaces the orginal /help in minecraft and you are able to put as many lines as you like!

Does Support Chatcolors e.g. "&cRed Helping or &6Gold Helping!"

world-guard This config section contain's events that get canceled by player's without the permission to do so.

messaging This config is for the /dm and /re commands! You can configure these for what the player uses.

sql Our library supports the use of PostgreSQL, feel free to use a different api for databases, this is just because the developer's of NR-Core prefer to use Postgresql over others like MariaDB. By default sql is not enabled

Clone this wiki locally