Configuration: Difference between revisions

From PurpleIRC Wiki
No edit summary
Line 4: Line 4:
The main configuration file, '''config.yml''', contains the global settings for '''PurpleIRC'''.  
The main configuration file, '''config.yml''', contains the global settings for '''PurpleIRC'''.  


<include src="http://raw.githubusercontent.com/cnaude/PurpleIRC/master/src/main/resources/config.yml" highlight="php" />
<include src="http://raw.githubusercontent.com/cnaude/PurpleIRC/master/src/main/resources/config.yml" highlight="yaml" />


== Bot Config (botname.yml) ==
== Bot Config (botname.yml) ==

Revision as of 17:54, 2 August 2015

Configuration of PurpleIRC is a fairly straightforward process. There is one main configuration file and one or more bot files. All of the configuration files are store in YAML format.

Main Config (config.yml)

The main configuration file, config.yml, contains the global settings for PurpleIRC.

<include src="http://raw.githubusercontent.com/cnaude/PurpleIRC/master/src/main/resources/config.yml" highlight="yaml" />

Bot Config (botname.yml)

This is a sample bot file. Read each option and change as needed.

<include src="http://raw.githubusercontent.com/cnaude/PurpleIRC/master/src/main/resources/SampleBot.yml" highlight="php" />