-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathbot_strings.py
More file actions
130 lines (122 loc) · 13 KB
/
bot_strings.py
File metadata and controls
130 lines (122 loc) · 13 KB
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
from config import settings
# ABOUT
# These strings are what is output as the result of a pm, request or action in the code. You should change these to reflect your instance.
# A \n indicates a break/new line. A \n\n indicates two new lines, i.e. the start of a new paragraph.
# Some lines contain variables inside of {} - like {report_id} for example. You probably shouldn't change these, but I'm not your mum so do whatever you want.
# A string should always start and end in "" - failure to do so will probably break the bot.
# Some particularly long strings have been split over lines so they're easier to read for humans. They start and end in brackets, i.e. () - if you use this format, make sure to keep the brackets.
# Some may start with commas or spaces - this is to make sure the message
# can be read properly. I recommend following the format too so your bot's
# messages are legible.
## INSTANCE SPECIFIC CONFIG ##
BOT_NAME = "ZippyBot"
FEEDBACK_URL = "https://feedback.lemmy.zip"
## GENERAL ##
GREETING = "Hey,"
PM_SIGNOFF = "I am a Bot. If you have any queries, please contact [Demigodrick](/u/demigodrick@lemmy.zip) or [Sami](/u/sami@lemmy.zip). Beep Boop."
AUTOPOST_HELP = (
"These are the commands you'll need to schedule an automatic post. Remember, you'll need to be a moderator in the community otherwise this won't work. \n \n"
"A typical command would look like `#autopost -c community_name -t post_title -b post_body -d day -h time -f frequency` \n"
"- `-c` - This defines the name of the community you are setting this up for. This is the original name of the community when you created it. \n"
"- `-t` - This defines the title of the post. You can use the modifiers listed below here. \n"
"- `-b` - This is the body of your post. This field is optional, so you don't need to include it if you don't want a body to your post. You can use the modifiers listed below here too. \n"
"- `-u` - This defines a URL you can add to your post. This field is optional, so you don't need to include it. \n"
"- `-d` - This defines a date you want the first post to occur in YYYYMMDD format, i.e. `20230612` which would be 12th June 2023, or the day of the week you want your thread to be posted on, i.e. `monday`. \n"
"- `-h` - This defines the time of the day you want this thread to be posted, i.e. `12:00`. All times are UTC! \n"
"- `-f` - This defines how often your thread will be posted. The options that currently exist are `once`, `weekly`, `fortnightly`, `4weekly`, or `monthly`. \n\n"
"There are some modifiers you can use as outlined above: \n"
"- `%d` - This will be replaced by the day of the month, i.e. `12` \n"
"- `%m` - This will be replaced by the name of the month, i.e. `June`. \n"
"- `%y` - This will be replaced by the current year, i.e. `2024` \n"
"- `%w` - This will be replaced by the day of the week, i.e. `Monday`.\n\n"
"For example, having `-t Weekly Thread %d %m` might be created as `Weekly Thread 12 June` depending on the day it is posted. \n\n"
"Finally, if you want to delete a scheduled autopost, use the command `#autopostdelete` with the ID number of the autopost, i.e. `#autopostdelete 1`. You can also delete the latest pinned thread if you include `y` at the end, i.e `#autopostdelete 1 y`. \n\n If you need any further help getting this working, please contact [Demigodrick](/u/demigodrick@lemmy.zip).")
SUB_ERROR = "Sorry, something went wrong with your request :( \n\n Please message [Demigodrick](/u/demigodrick@lemmy.zip) or [Sami](/u/sami@lemmy.zip) directly to let them know, and they'll sort it out for you."
EMAIL_SUBJECT = "Thanks for signing up to Lemmy.zip!"
WELCOME_MESSAGE = (
"\n\n # Welcome to Lemmy.zip! \n\n Please take a moment to familiarise yourself with [our Welcome Post](https://lemmy.zip/post/43). (Text that looks like this is a clickable link!) \n\n"
"This post has all the information you'll need to get started on Lemmy, so please have a **good read** first! \n\n"
"You might also find it useful to have a look at the [New to Lemmy](/c/newtolemmy@lemmy.ca) community for tips on getting started! \n\n"
"Please also take a look at our rules, they are in the sidebar of this instance, or you can view them [here](https://legal.lemmy.zip/posts/code_of_conduct/), or I can send these to you at any time - just send me a message with `#rules`. \n \n"
"If you're on a mobile device, you can [tap here](https://m.lemmy.zip) to go straight to our mobile site. \n \n"
"Lemmy.zip is 100% funded by user donations, so if you are enjoying your time on Lemmy.zip please [consider donating](https://opencollective.com/lemmyzip).\n \n"
"Want to change the theme of the site? You can go to your [profile settings](https://lemmy.zip/settings) (or click the dropdown by your username and select Settings) and scroll down to theme. You'll find a list of themes you can try out and see which one you like the most! \n \n"
"You can also set a Display Name that is different from your account username by updating the Display Name field. By default, your Display Name will show up to other users as `@your_username`, but by updating this field it will become whatever you want it to be! \n \n"
"Finally, we've set your account up with some blocks in place. We do this to help you settle in to Lemmy. You can find more details (and how to turn this off) in the [Welcome Post](https://lemmy.zip/post/43). \n\n"
"PS - We also have a Mastodon server. Not already on Mastodon? [Join us here!](https://mastodon.zip/invite/NsRaEdjM) \n\n"
"If you'd like more help, please reply to this message with `#help` for a list of things I can help with. \n\n"
"--- \n \n")
MOD_ADVICE = (
"Here are some tips for getting users to subscribe to your new community!\n"
"- Try posting a link to your community at [New Communities](/c/newcommunities@lemmy.world) and at [CommunityPromo](/c/communityPromo@lemmy.ca)\n"
"- Your community is automatically part of the [Lemmy Federate](https://lemmy-federate.com/) project, so it is immediately shared to a bunch of other instances.\n"
"- Ensure your community has some content. Users are more likely to subscribe if content is already available. (5 to 10 posts is usually a good start)\n"
"- There are a couple of mod tools you can use to support your community. You can see the details on our Mod Tools [by clicking here!](/c/modtools@lemmy.zip) \n"
"- Consistency is key - you need to post consistently and respond to others to keep engagement with your new community up.\n\n"
"I hope this helps! \n \n")
## REPORTS ##
REPORT_LOCAL = "Thanks for submitting a report. This is just a message to let you know the mods and admins have recieved this report. We'll check if the reported content breaks our [Code of Conduct](https://legal.lemmy.zip/posts/code_of_conduct/) and take action accordingly."
REPORT_REMOTE = "Thanks for submitting a report. As this content is on Lemmy.zip, we'll check if it breaks our [Code of Conduct](https://legal.lemmy.zip/posts/code_of_conduct/) and take action accordingly. Your local admin(s) will also recieve a copy of this report."
# PM REPLIES
INS_RULES = (
"These are the current rules for Lemmy.zip. \n \n"
"- Please abide by the [General Code of Conduct](https://join-lemmy.org/docs/en/code_of_conduct.html) at all times.\n"
"- Remember the human! (no harassment, threats, etc.)\n"
"- No racism or other discrimination\n"
"- No endorsement of hate speech\n"
"- No self-advertisements or spam\n"
"- No link-spamming\n"
"- No content against UK law.\n"
"- Any NSFW post must be tagged as NSFW. Failure to do so will be given one warning only\n"
"- Anything that you wouldn’t want your boss or coworkers to see, needs to be tagged NSFW\n"
"- NSFW also acts as “Content Warning” outside of the specific NSFW communities\n\n"
"Any posts or comments that are in breach of these rules will be dealt with, and remediation will occur. Whether that be a warning, temporary ban, or permanent ban.\n\n"
"(TLDR) The crux of it boils down to:\n"
"- Remember that we are all humans\n"
"- Don’t be overtly aggressive towards anyone\n"
"- Try and share ideas, thoughts and criticisms in a constructive way\n"
"- Tag any NSFW posts as such \n\n")
BOT_COMMANDS = (
"These are the commands I currently know:" + "\n\n "
"- `#help` - See this message. \n "
"- `#rules` - See the current instance rules. \n"
"- `#vote` - Vote on an active poll. You'll need to have a vote ID number. An example vote would be `#vote 1 yes` or `#vote 1 no`.\n"
"- `#credits` - See who spent their time making this bot work! \n"
"- `#autopost` - If you moderate a community, you can schedule an automatic post using this option. Use `#autoposthelp` for a full command list. \n"
"- `#rss` - If you moderate a community, you can use RSS feeds to populate it. Use `#rsshelp` for more information. \n\n")
BOT_ADMIN_COMMANDS = (
"As an Admin, you also have access to the following commands: \n"
"- `#poll` - Create a poll for users to vote on. Give your poll a name, and you will get back an ID number to users so they can vote on your poll. Example usage: `#poll @Vote for best admin` \n"
"- `#closepoll` - Close an existing poll using the poll ID number, for example `#closepoll @1`\n"
"- `#countpoll` - Get a total of the responses to a poll using a poll ID number, for example `#countpoll @1` \n"
"- `#takeover` - Add a user as a mod to an existing community. Command is `#takeover` followed by these identifiers in this order: `-community_name` then `-user_id` (use `-self` here if you want to apply this to yourself) \n\n")
THREAD_LOCK_MESSAGE = (
"This thread has been locked by the Lemmy.zip Admin Team.")
RSS_HELP = (
"These are the commands you'll need to add an RSS Feed to your community. Please note, you'll need to be a moderator of that community in order to use this tool. \n\n"
"This works by pulling the three latest posts in the RSS feed and checking if they've already been posted or not. If not, and they match the appropriate filters (if set) then ZippyBot will post the content. This does mean on the first use you will get 3 posts. \n\n"
"A typical command would look like `#rss -url rss_url -c community name` - but there are a few modifiers you can use. \n"
"- `url` - This is the URL of the rss feed, and is mandatory. \n"
"- `c` - This is the community name and is mandatory. \n"
"- `t` - This will tag your post titles with a preceding tag in square brackets, i.e. `-t \"RSS POST\"` will result in each post being tagged with `[RSS POST]` \n."
"- `title_inc` - Adding this will mean that only posts that INCLUDE the string you define will be posted, i.e. `-title_inc \"title must be included\"`. The speech marks are mandatory if you use this option, and you can have multiple filters by using a commma between them. \n"
"- `title_exc` - Adding this will EXCLUDE any posts that match this string, i.e. `-title_exc \"dont include this\"`. The speech marks are mandatory if you use this option. \n"
"- `url_inc` - Adding this will filter the post based on the link to the content in the RSS feed. You can use it in a way such as `-url_inc \"goodlink.com\"` to ensure that only posts where the link to the content is for `goodlink.com`. Speech marks are mandatory.\n"
"- `url_exc` - Adding this will exclude content based on the link to the content RSS feed, such as `-url_exc \"badlink.com\"`. Speech marks are mandatory. \n"
"- `new_only` - Adding this will mean that on the creation of this RSS feed, ZippyBot won't scan for existing posts and only start looking at posts after starting this feed. \n\n"
"Finally, if you want to delete an RSS feed from your community, use the command `#rssdelete` with the ID number of the RSS feed, i.e. `#rssdelete 1`. \n\n If you need any further help getting this working, please contact [Demigodrick](/u/demigodrick@lemmy.zip).")
LOCAL_ONLY_WARNING = (
"This bot is only for users of Lemmy.zip. Maybe try signing up there instead if you'd like to try me out!")
CREDITS = (
"This bot was built with help and support from various Lemmy.zip community members and contributers: \n\n"
"- [Demigodrick](https://me.lemmy.zip/@demigodrick) - Original Creator\n"
"- [Sami](/u/sami@lemmy.zip) - Support with original idea and implementation \n"
"- [TheDude](/u/TheDude@sh.itjust.works) - Refactoring of code and support with improving inital implementation \n"
"- [efwis](/u/efwis@lemmy.zip) - code contributions regarding new user database \n"
"- [Db0](/u/db0@lemmy.dbzer0.com) - For Pythorhead, which this bot is built with!")
UNSUB_MESSAGE = (
"Your unsubscribe request was successful. You can resubscribe at any time by sending me a message with `#subscribe`.")
SUB_MESSAGE = (
"Your subscribe request was successful. You can unsubscribe at any time by sending me a message with `#unsubscribe`")
FEEDBACK_MESSAGE = (
f"The access code for the feedback survey is {settings.SURVEY_CODE}\n\n You can access the survey by [clicking here]({FEEDBACK_URL}) and selecting the available survey.")