Class: Cinch::Configuration::Bot

Inherits:
Cinch::Configuration show all
Defined in:
lib/cinch/configuration/bot.rb

Overview

Since:

  • 2.0.0

Constant Summary collapse

KnownOptions =

Since:

  • 2.0.0

%i[server port ssl password nick nicks
realname user messages_per_second server_queue_size
strictness message_split_start message_split_end
max_messages plugins channels encoding reconnect max_reconnect_delay
local_host timeouts ping_interval delay_joins dcc shared sasl default_logger_level].freeze

Class Method Summary collapse

Methods inherited from Cinch::Configuration

#[], #[]=, #initialize, #load, #load!, #to_h

Constructor Details

This class inherits a constructor from Cinch::Configuration

Class Method Details

.default_config ⇒ Hash

Generate a default configuration.

Returns:

  • (Hash)

Since:

  • 2.0.0



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/cinch/configuration/bot.rb', line 16

def self.default_config
  {
    server: "localhost",
    port: 6667,
    ssl: Configuration::SSL.new,
    password: nil,
    nick: "cinch",
    nicks: nil,
    realname: "cinch",
    user: "cinch",
    modes: [],
    messages_per_second: nil,
    server_queue_size: nil,
    strictness: :forgiving,
    message_split_start: "... ",
    message_split_end: " ...",
    max_messages: nil,
    plugins: Configuration::Plugins.new,
    channels: [],
    encoding: :irc,
    reconnect: true,
    max_reconnect_delay: 300,
    local_host: nil,
    timeouts: Configuration::Timeouts.new,
    ping_interval: 120,
    delay_joins: 0,
    dcc: Configuration::DCC.new,
    sasl: Configuration::SASL.new,
    shared: {},
    default_logger_level: :debug,
  }
end