oddluck-limnoria-plugins/TriviaTime/config.py

###
# Copyright (c) 2013, tann <tann@trivialand.org>
# Copyright (c) 2020, oddluck <oddluck@riseup.net>
# 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.
#   * Neither the name of the author of this software nor the name of
#     contributors to this software may be used to endorse or promote products
#     derived from this software without specific prior written consent.
#
# 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 OWNER 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.
###

import supybot.conf as conf
import supybot.registry as registry


def configure(advanced):
    # This will be called by supybot to configure this module.  advanced is
    # a bool that specifies whether the user identified himself as an advanced
    # user or not.  You should effect your configuration by manipulating the
    # registry as appropriate.
    from supybot.questions import expect, anything, something, yn

    conf.registerPlugin("TriviaTime", True)


TriviaTime = conf.registerPlugin("TriviaTime")

# Config groups
conf.registerGroup(TriviaTime, "kaos")
conf.registerGroup(TriviaTime, "admin")
conf.registerGroup(TriviaTime, "questions")
conf.registerGroup(TriviaTime, "general")
conf.registerGroup(TriviaTime, "commands")
conf.registerGroup(TriviaTime, "voice")
conf.registerGroup(TriviaTime, "skip")
conf.registerGroup(TriviaTime, "hints")

# CONFIGURATION
# file locations for database and question
conf.registerChannelValue(
    TriviaTime.admin,
    "db",
    registry.String(
        """plugins/TriviaTime/storage/db/trivia.db""",
        """Location of sqlite database file""",
    ),
)

conf.registerChannelValue(
    TriviaTime.admin,
    "file",
    registry.String(
        """plugins/TriviaTime/storage/questions""",
        """Location of question file. Reload the plugin if changed.""",
    ),
)

# timeout, number of hints, values
conf.registerChannelValue(
    TriviaTime.commands,
    "extraHint",
    registry.NormalizedString(
        """~""", """The command to show extra hints and remaining KAOS"""
    ),
)

conf.registerChannelValue(
    TriviaTime.general,
    "logGames",
    registry.Boolean(True, """Log changes to questions and games"""),
)

conf.registerChannelValue(
    TriviaTime.general,
    "globalStats",
    registry.Boolean(False, """Stats are global across all channels"""),
)

conf.registerChannelValue(
    TriviaTime.hints,
    "extraHintTime",
    registry.Integer(
        10,
        """Number of seconds a user must wait between uses of the extra hint command.""",
    ),
)

conf.registerChannelValue(
    TriviaTime.hints,
    "vowelsHint",
    registry.Boolean(
        True,
        """Show all vowels on the third hint. If false, random letters will be shown instead""",
    ),
)

conf.registerChannelValue(
    TriviaTime.general,
    "showStats",
    registry.Boolean(True, """Show player stats after correct answer"""),
)

conf.registerChannelValue(
    TriviaTime.skip,
    "skipThreshold",
    registry.Float(
        0.50,
        """Percentage of active players who need to vote for a question to be skipped""",
    ),
)

conf.registerChannelValue(
    TriviaTime.skip,
    "skipActiveTime",
    registry.Integer(
        (30 * 60),
        """Amount of seconds a user is considered active after answering a question""",
    ),
)

conf.registerChannelValue(
    TriviaTime.skip,
    "skipTime",
    registry.Integer(
        90, """Seconds a user must wait to skip a question again after skipping"""
    ),
)

conf.registerChannelValue(
    TriviaTime.questions, "hintTime", registry.Integer(15, """Seconds between hints""")
)

conf.registerChannelValue(
    TriviaTime.kaos, "hintKAOS", registry.Integer(20, """Seconds between KAOS hints""")
)

conf.registerChannelValue(
    TriviaTime.general,
    "waitTime",
    registry.Integer(
        20, """Seconds between the end of one question and the start of another"""
    ),
)

conf.registerChannelValue(
    TriviaTime.voice,
    "enableVoice",
    registry.Boolean(False, """Voice top players for week, month, and year"""),
)

conf.registerChannelValue(
    TriviaTime.hints,
    "enableExtraHints",
    registry.Boolean(
        True, """Shows extra hint using command. Rate-limited by default"""
    ),
)

conf.registerChannelValue(
    TriviaTime.voice,
    "timeoutVoice",
    registry.Integer(
        60,
        """The minimum amount of seconds between anouncing the topped users that were voiced""",
    ),
)

conf.registerChannelValue(
    TriviaTime.voice,
    "numTopToVoice",
    registry.Integer(25, """The number of top players who are elligible for voice"""),
)

conf.registerChannelValue(
    TriviaTime.voice,
    "minPointsVoiceWeek",
    registry.Integer(
        750, """Points required to be voiced for being top player in the week"""
    ),
)

conf.registerChannelValue(
    TriviaTime.voice,
    "minPointsVoiceMonth",
    registry.Integer(
        5000, """Points required to be voiced for being top player in the month"""
    ),
)

conf.registerChannelValue(
    TriviaTime.voice,
    "minPointsVoiceYear",
    registry.Integer(
        25000, """Points required to be voiced for being top player in the year"""
    ),
)

conf.registerChannelValue(
    TriviaTime.kaos,
    "payoutKAOS",
    registry.Integer(10, """Extra points for teamwork on KAOS"""),
)

conf.registerChannelValue(
    TriviaTime.general,
    "timeout",
    registry.Integer(604800, """Time before game shuts off in seconds"""),
)

conf.registerChannelValue(
    TriviaTime.questions,
    "defaultPoints",
    registry.Integer(
        10, """Default points for a correct answer to a normal question"""
    ),
)

conf.registerChannelValue(
    TriviaTime.kaos,
    "defaultKAOS",
    registry.Integer(15, """Default points for a correct KAOS answer"""),
)

conf.registerChannelValue(
    TriviaTime.hints,
    "hintRatio",
    registry.Integer(35, """Percent of word to show per hint"""),
)

conf.registerChannelValue(
    TriviaTime.hints,
    "charMask",
    registry.NormalizedString("*", """Masking character for hints"""),
)

conf.registerChannelValue(
    TriviaTime.general,
    "nextMinStreak",
    registry.Integer(5, """The streak needed to use the Next command"""),
)

conf.registerChannelValue(
    TriviaTime.general,
    "minBreakStreak",
    registry.Integer(4, """The streak needed to award breaking the streak"""),
)

# vim:set shiftwidth=4 tabstop=4 expandtab textwidth=79: