documentation/Config.yml Guide

Config.yml Guide

It's rather simple to setup the config.yml file for a simple register and play server. It's also not very hard to setup the config.yml for the other features that McX has. Look through this example, which explains what you put for each node.

# Configuration File

## Enter The MySQL configuration category.
mysql:

    forumtype: phpbb
# # This is the type of forum you are going to use with McX. The
# # compatible forums can be found in the related documentation page.

    verifyuser: admin
# # This is the user account (Minecraft user) that will verify various
# # actions in the plugin to make sure they work. I recommend just
# # setting this to your Minecraft username.

    host: localhost
# # This is the host address of the MySQL server for your forum.
# # This is usually `localhost` if the forum is being hosted on the
# # same computer/server/vps as the minecraft server.

    port: '3306'
# # This is the port to connect to the MySql server. Leave
# # this at 3306 unless you are an advanced user and
# # know what you are doing.

    user: root
# # This is the MySQL user that has privileges to access the
# # MySQL database for your forum.

    password: password1
# # This is the password for the MySQL user.

    database: myforumsdatabasename
# # This is the name of the MySQL database for your forum.

    prefix: phpbb_
# # This is the prefix of all the tables in the MySQL database.


## Enter the general configuration
general:

    type: Greylist
# # This is the type restriction you want your server to use. This can
# # be either `Greylist` or `Whitelist`.

    authType: Field
# # This is the type of authentication you want the plugin to use. It is
# # the way that the plugin gets the minecraft username to verify. This
# # can be either `Field` or `Username`.

    syncGroups: 'false'
# # Should McX syncronise the permission groups on the server with
# # the groups on the forum?
# # Read more on how to do this in the relative documentation page.

    groupOverride: 'false'
# # **Only applys to Group Sync** Should McX overwrite all groups
# # that the user has to synchronize with the groups on the forum
# # or just add the group?

# # GreyList options for unregistered users
    greylist:
        protection:

            damageEntities: 'true'
    # # Deny the user be able to kill/hit other entities in game?
    # # E.g. Other users or mobs

            lootItems: 'true'
    # # Deny the user to be able to loot items from the ground or chest?

            dropItems: 'true'
    # # Deny the user to be able to drop items from their inventories?

            chat: 'true'
    # # Deny the user the ability to chat to other player?

            interact: 'true'
    # # Deny the user to be able to interact in the game?

            command: 'true'
    # # Deny the user to type commands?

## Define the field id for use with custom field authentication
field:
    id: '1'

## Enter the economy category
economy:

    enabled: 'false'
# # Enable the economy feature?

    moneyPerPost: 0
# # This is how much money should be rewarded for each forum
# # post the user makes.

    checkRate: 8
# # This is how often should McX check for new forum posts
# # and reward the users, in **minutes**.

    lastCheck: 0
# # The seconds since the Unix Epoch (1st Jan 1970) when the last check was made.
# # I recommend you leave this alone unless you are crazy in the head :)
# (( If you don't understand much of this.. Don't worry and carry on with the rest of your life :). ))
# #   However, remember that this saves each time the users are
# #   rewarded/checked for forum posts. So make sure you don't
# #   save an old check num when a new check has been
# #   preformed else you will add extra money to the users who
# #   posted in this time period.

Comments

Posts Quoted:
Reply
Clear All Quotes