GuessTheSubreddit/settings.yml.example at master · OneUpPotato/GuessTheSubreddit · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
subreddit: GuessTheSubreddit

toggles:
    # Whether the bot make a post when it starts up.
    post_on_start: true

    # Should the posts be checked when the bot starts.
    # The bot checks for posts to close every 5 minutes regardless.
    check_posts_on_start: false

# How long a post should be open for until guessing is stopped. (in minutes)
post_expiry_time: 360

# The flair settings.
flairs:
    post:
        standard: c1547c0c-4049-11ea-bce8-0e3a3e501ba9
        multi: cf9cf898-4049-11ea-9cd2-0e3247f312c5
        fillblank: 63ee0c44-49fa-11ea-a5e2-0e9b2137d67d
        jumbled: 43da7fd4-bfb9-11ea-8ba0-0ee5376e3101
        sounds: 5ebc2f3c-2215-11eb-ae98-0e97d626b887
        revealed: 66035734-2215-11eb-9949-0e61a9885c6b
    user:
        score:
            id: b76716ce-4048-11ea-804a-0e638e9bf59b
            text: "△{}"

# Settings for each post type.
types:
    standard:
        points_awarded: 4
        type_text: ""
    fillblank:
        points_awarded: 3
        type_text: |-
            *Fill in the Blank*

            {}
    jumbled:
        points_awarded: 2
        type_text: |-
            *Unscramble the Letters*

            {}
    multi:
        points_awarded: 1
        type_text: |-
            *Possible Subreddits:*

            * r/{}
            * r/{}
            * r/{}
            * r/{}

        # When a subreddit that is in this list is selected, there is a chance that the other subreddit will be shown with it.
        groupings:
            -
                - aww
                - dog_pictures
            -
                - example1
                - example2
            -
                - example3
                - example4
    sounds:
        points_awarded: 2
        type_text: |-
            *Vowels and Consonants*

            {}
    revealed:
        points_awarded: 2
        type_text: |-
            *Revealed Letters*

            {}

# General Templates
templates:
    posts:
        weekly_update: |-
            # Beep Boop!

            It's that time of the week. Here's the weekly statistics update.

            &#x200B;

            # Top of the Week

            The users who have gained the most points this week.

            |**Place**|**Username**|**Points Gained (this week)**|
            |:-|:-|:-|
            {weekly_leaderboard}

            &#x200B;

            # Current Leaderboard

            The leaderboard as of the time of this post.

            {current_leaderboard}

            &#x200B;
    comments:
        post:
            main: |-
                {header}

                Please note that only top-level comments will be checked by the bot.

                [](#closure_info){closure_info}[](#closure_info_end)
                [](#type_text){type_text}[](#type_text_end)

                [Click here to learn more about this subreddit.](https://reddit.com/r/guessthesubreddit/wiki/index)
            headers:
                default: "**Guessing is still open for this post. Please go ahead and have a go.**"
                complete: "**~~Guessing is still open for this post.~~**"
            closure_info:
                default: This post closes on {closing_time} UTC ^(D/M/Y)
                complete: |-
                    The post came from the subreddit >!r/{subreddit}!<

                    [You can find the post (made by u/{author}) here.]({permalink})
        reply:
            correct: "**Result:** >!CORRECT - Your score has been increased. (+{points} points)!<"
            incorrect: "**Result:** >!INCORRECT - The correct subreddit was /r/{correct_subreddit}!<"
            not_allowed: "**Result:** !>You've already guessed correctly on this post.!<"
    sidebars:
        widget: "{leaderboard}"
        sidebar: |-
            # Rules

            1. Remain civilised.

            2. Don't ruin it by cheating.

            3. Please report broken posts.

            # How does this subreddit work?

            1. A post is made by the bot every 30 minutes.

            3. The post is left open for 6 hours to allow people to try and guess what subreddit that post has come from..

            4. After 6 hours, the post will be locked and points will be awarded to the users who guessed correctly.

            We currently suggest that you sort by new when looking for posts.

            [You can learn more about how it works on our wiki.](https://www.reddit.com/r/guessthesubreddit/wiki/index)

            # Where can I suggest ideas?

            You can leave a comment on any mod/meta thread, send a modmail to this subreddit or [join the Discord.](https://discord.gg/RCtd7qx)

            # Who made the bot? Can I contribute?

            The bot was made by myself (u/OneUpPotato).

            [You can help contribute to the bot, or just have a look at the code, on GitHub.](https://github.com/OneUpPotato/GuessTheSubreddit)

            # Points Leaderboard

            {leaderboard}