Pages

Settings

Configuration Setup

This is the main configuration setup, it can be found in your plugins/MonsterIRC folder as Settings.yml
If you don't know how to use a YAML this is an example of the correct YAML syntax
If you are still having issues use a YAML parser to check your files

IRC:

SETTINGS:

IDENTIFY: true or false
True if you want the bot to identify with nickserv; otherwise false.
NICKNAME: Nickname
This is the name the IRC bot will use in its channel
PASSWORD: Password
This is the password that will be sent to identify via Nickserv How to register with nickserv
SERVER: irc.esper.net
This is the IRC server you are currently using
PORT: 6667
This is the port the bot will connect trough. Change this if you are not using the default port on your IRC server
SERVER_PASSWORD: ''
This is the password that will be sent to join the IRC server

OPTIONS:

MESSAGE_LIMIT_PER_SECOND: 2
This is the amount of messages that can be sent per second from the Message Queue. To ignore this, write 0
TIMEOUT: 2000
This is the amount of time (in MS) the IRC bot to wait for the server to respond before killing the connection on one try.
RETRYS: 5
This is the number of tries the IRC bot will attempt to connect to the server when it doesn't respond before simply disabling the plugin.
DEBUG: true or false
Whether or not you want to print all lines in the console including errors and server-connetion details
PASS_ON_NAME: true or false
Whether or not you want the users to type the bot's name in order to send their message to game's chat
ALLOW_COLORS: true or false
True if you want to allow colors from game to be sent to the IRC channel otherwise, false

ADMIN:

INGAME_COMMANDS: true or false
Whether or not you want to allow IRC ops to execute InGame commands from IRC
INGAME_COMMANDS_PREFIX: Prefix
Write whatever you want your IRC ops to type before executing any ingame command so that if you set this to ! the command will be : !give Shayana_fr 57 64
PASS_SAY_COMMAND true or false
True will enable the incoming messages from console in the IRC channel
FORMAT:
MINECRAFT: '<{world}{groupPrefix}{prefix}{name}{suffix}{groupSuffix}> : {message}'
This is the format of InGame messages coming from IRC
IRC: '<{world}{herochatTag}{groupPrefix}{prefix}{name}{suffix}{groupSuffix}> : {message}'
This is the format of IRC messages coming from game.
ON_CONNECT_COMMANDS: ''
The commands you would like to perform when the bot connects to the channel. It has to be listed one command per line, preceded by a -
MUTED:
- sampleuser
Just replace - sampleuser with the - players you don't want to read on your channels.




Formatting messages

Above are listed lots of options for the message formatting, here are the details to correctly set this up.
Please notice this will not overwrite your chat plugin format, it will instead work as an additional format.

! You must keep the ' ' characters be on both extremities of the lines !



Variables :

  • {name} : This is the nickname of your user, do not delete it.
  • {world} : Your world name, as set in bukkit folders
  • {mvWorld} : The multiverse world alias
  • {mvColor} : The multiverse world color
  • {groupPrefix} : ...
  • {prefix} : ...
  • {groupSuffix} : ...
  • {suffix} : Last four options are displayed as defined by your permissions plugin Requires Vault!
  • {message} : Don't delete it neither, this is the message sent.
  • {herochatTag} : Turns on the Herochat tag (like [G]) as set in the HeroChat channel's config (only for IRC formatting!)
  • {HCchannelColor} : Sets the message to the color of the herochat channels tag

  • {channel} : Use the IRC channel in messages going to game

    Additional changes :

  • < > are optional
  • You can add whatever you want to this format, just make sure it is YAML friendly
  • Colors can be set using this codes, just replace #s by &s:

Minecraft Color code

Comments

Posts Quoted:
Reply
Clear All Quotes