diff --git a/LICENSE b/LICENSE index 79bd54b..99ca34a 100644 --- a/LICENSE +++ b/LICENSE @@ -1,27 +1,27 @@ -This software is licensed under the 2-clause Simplified BSD License. A copy of -this license is provided below. - -Copyright (c) 2013, Jimmy Cao -All rights reserved. - -Redistribution and use in source and binary forms, with or without modification, -are permitted provided that the following conditions are met: - - * Redistributions of source code must retain the above copyright notice, this - list of conditions and the following disclaimer. - - * Redistributions in binary form must reproduce the above copyright notice, - this list of conditions and the following disclaimer in the documentation - and/or other materials provided with the distribution. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR -ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES -(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; -LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON -ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT -(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS -SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. - +This software is licensed under the 2-clause Simplified BSD License. A copy of +this license is provided below. + +Copyright (c) 2013, Jimmy Cao +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, +are permitted provided that the following conditions are met: + + * Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + + * Redistributions in binary form must reproduce the above copyright notice, + this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND +ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED +WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE +DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR +ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES +(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; +LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON +ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS +SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + diff --git a/README b/README index af4feb5..9ae2d33 100644 --- a/README +++ b/README @@ -1,4 +1,4 @@ -Use Python 3.2 (3.1 doesn't work) -configure botconfig.py by following the example in botconfig.py.example -if desired, configure settings/wolfgame.py to modify game settings -run wolfbot.py +Use Python 3.2 (3.1 doesn't work) +configure botconfig.py by following the example in botconfig.py.example +if desired, configure settings/wolfgame.py to modify game settings +run wolfbot.py diff --git a/botconfig.py.example b/botconfig.py.example index 79c1794..37346f4 100644 --- a/botconfig.py.example +++ b/botconfig.py.example @@ -1,39 +1,39 @@ -PASS = "my_nickserv_pass" -CHANNEL = "#mywolfgame" -HOST = "irc.freenode.net" -PORT = 6667 -USERNAME = "" # for authentication, can be left blank if same as NICK -NICK = "mywolfbot" -CMD_CHAR = "!" -CHANGING_HOST_QUIT_MESSAGE = "Changing host" - -SASL_AUTHENTICATION = False # put account name in USERNAME ^ if different from nick -USE_SSL = False -DISABLE_DEBUG_MODE = False # Entirely disable debug mode -IGNORE_HIDDEN_COMMANDS = True # Ignore commands sent to @#channel or +#channel -ALLOW_NOTICE_COMMANDS = False # allow /notice #channel !command to be interpreted as a command -ALLOW_PRIVATE_NOTICE_COMMANDS = False # allow !command's from /notice (Private) - -ALLOWED_NORMAL_MODE_COMMANDS = [] # debug mode commands to be allowed in normal mode - -OWNERS = ("unaffiliated/wolfbot_admin1",) # the comma is required at the end if there is one owner -ADMINS = ("unaffiliated/wolfbot_admin2", "unaffiliated/wolfbot_admin3") # glob syntax supported (wildcards) -ALLOW = {"cloakof/fwaiter": ("fwait",), - "cloakof/?omeone_else": ("fday","fnight")} -DENY = {} - -# Stop editing here - -# Argument --debug means start in debug mode -# --verbose means to print a lot of stuff (when not in debug mode) -import argparse -parser = argparse.ArgumentParser() -parser.add_argument('--debug', action='store_true') -parser.add_argument('--sabotage', action='store_true') -parser.add_argument('--verbose', action='store_true') - -args = parser.parse_args() -DEBUG_MODE = args.debug if not DISABLE_DEBUG_MODE else False -VERBOSE_MODE = args.verbose - -DEFAULT_MODULE = "sabotage" if args.sabotage else "wolfgame" +PASS = "my_nickserv_pass" +CHANNEL = "#mywolfgame" +HOST = "irc.freenode.net" +PORT = 6667 +USERNAME = "" # for authentication, can be left blank if same as NICK +NICK = "mywolfbot" +CMD_CHAR = "!" +CHANGING_HOST_QUIT_MESSAGE = "Changing host" + +SASL_AUTHENTICATION = False # put account name in USERNAME ^ if different from nick +USE_SSL = False +DISABLE_DEBUG_MODE = False # Entirely disable debug mode +IGNORE_HIDDEN_COMMANDS = True # Ignore commands sent to @#channel or +#channel +ALLOW_NOTICE_COMMANDS = False # allow /notice #channel !command to be interpreted as a command +ALLOW_PRIVATE_NOTICE_COMMANDS = False # allow !command's from /notice (Private) + +ALLOWED_NORMAL_MODE_COMMANDS = [] # debug mode commands to be allowed in normal mode + +OWNERS = ("unaffiliated/wolfbot_admin1",) # the comma is required at the end if there is one owner +ADMINS = ("unaffiliated/wolfbot_admin2", "unaffiliated/wolfbot_admin3") # glob syntax supported (wildcards) +ALLOW = {"cloakof/fwaiter": ("fwait",), + "cloakof/?omeone_else": ("fday","fnight")} +DENY = {} + +# Stop editing here + +# Argument --debug means start in debug mode +# --verbose means to print a lot of stuff (when not in debug mode) +import argparse +parser = argparse.ArgumentParser() +parser.add_argument('--debug', action='store_true') +parser.add_argument('--sabotage', action='store_true') +parser.add_argument('--verbose', action='store_true') + +args = parser.parse_args() +DEBUG_MODE = args.debug if not DISABLE_DEBUG_MODE else False +VERBOSE_MODE = args.verbose + +DEFAULT_MODULE = "sabotage" if args.sabotage else "wolfgame"