Configuration: Difference between revisions

From PurpleIRC Wiki
No edit summary
 
(7 intermediate revisions by 2 users not shown)
Line 1: Line 1:
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.
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. Every option is documented in each file.


== Main Config (config.yml) ==
== Main Config (config.yml) ==
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="yml" />
[http://raw.githubusercontent.com/cnaude/PurpleIRC-spigot/master/src/main/resources/config.yml config.yml]


== Bot Config (botname.yml) ==
== Bot Config (botname.yml) ==
This is a sample bot file. Read each option and change as needed.
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="yml" />
[http://raw.githubusercontent.com/cnaude/PurpleIRC-spigot/master/src/main/resources/SampleBot.yml SampleBot.yml]

Latest revision as of 17:59, 10 February 2024

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. Every option is documented in each file.

Main Config (config.yml)

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

config.yml

Bot Config (botname.yml)

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

SampleBot.yml