laptopwiki:guides:discord:stickybot

Differences

This shows you the differences between two versions of the page.


Previous revision
—laptopwiki:guides:discord:stickybot [18/07/2024 21:11] (current) – [Run stickybot in the background] dustojnikhummer
Line 1: Line 1:
 +====== Stickybot ======
 +
 +Stickybot, sometimes known as Imaginifer, is the bot we use to send automatic announcement messages that are always at the bottom of a channel.\\
 +{{:laptopwiki:guides:discord:stickybot_example.png?700}}\\
 +Built by: [[https://discord.gg/HSdMQtaPEa|Spooker#0378]]\\
 +If you have any issues with this guide or feedback please contact [[https://discord.gg/HSdMQtaPEa|dustojnikhummerCZ#6262]]\\
 +\\
 +This guide assumes you are working without a GUI, most likely connected over SSH. If you are working with a Linux Desktop environment some of these steps can be done that way, like unzipping the archive.
 +
 +===== Requirements =====
 +
 +  * A Linux webhost
 +  * npm
 +  * npm dotenv (npm install dotenv)
 +  * nodejs
 +  * wget
 +  * unzip
 +  * Discord developer account
 +  * Linux Terminal
 +  * Basic knowledge of nano/micro text editors
 +
 +===== Download =====
 +
 +Download here: [[https://cdn.laptopwiki.eu/public/laptopwiki/stickybot.zip|CDN]]
 +
 +Unzip the archive and copy its contents to your Linux server. Alternatively, run:
 +<code>
 +
 +wget https://cdn.laptopwiki.eu/public/laptopwiki/sticky-message.zip
 +
 +</code>
 +
 +Then unzip the archive with:
 +
 +<code>
 +unzip ./sticky-message.zip -d ./sticky-message
 +
 +</code>
 +
 +If you want to move the folder somewhere else (or what to rename the folder) make sure to move the entire folder, not all of its contents. Linux's mv ./* does not move files hidden files (file starting with a .) and you might forget your .env file (which is very important). \\  \\ For example, you can move/rename the folder with the following command:
 +
 +<code>
 +mv ./sticky-message ./imaginifer
 +
 +</code>
 +
 +===== Bot Setup - Discord =====
 +
 +  - Open the [[https://discord.com/developers/applications|Discord Developer Portal]]
 +  - In the top right create a New Application and give it a name.
 +  - In the left panel select the Bot section. On the right click Add Bot.
 +  - Click the Reset Token button. Copy that token and do not lose it. Also make sure nobody else has that token.
 +  - In the left panel select OAuth2-URL Generator and select the bot scope. Below that a permission list will appear.
 +  - Select the permissions you want. Read Message History, Manage Messages, Send Messages at least. Add more if you want.
 +
 +{{:laptopwiki:guides:discord:stickybot_setup_scopes.png?300}}
 +
 +  * Below that will be a generated invite link for your bot. Use that link to invite the bot to the server you want to use it in.
 +
 +{{:laptopwiki:guides:discord:stickybot_server_invite.png?200}}
 +
 +  * Now you should see your bot in your server. You might need to invite it to some channels manually.
 +
 +{{:laptopwiki:guides:discord:stickybot_bot_offline.png?200}}
 +
 +===== Bot Setup - Host =====
 +
 +In the bot folder should be an .env file. If there isn't, create it:
 +<code>
 +
 +touch .env
 +
 +</code>
 +
 +Open it in Nano text editor:
 +
 +<code>
 +nano .env
 +
 +</code>
 +
 +The file should contain the following content (DO NOT USE CTRL+V in nano, type it manually):
 +
 +<code>
 +DISCORD_BOT_TOKEN=
 +
 +</code>
 +
 +Now add the token you generated in a previous section on this line, so it looks like the following example:
 +
 +<code>
 +DISCORD_BOT_TOKEN=MTAxMjYzMjA3NzM2RESTOFTHETOKEN
 +
 +</code>
 +
 +Press Ctrl+O and Enter to save changes and Ctrl+X to exit Nano.
 +
 +===== Installation =====
 +
 +Enter the bot folder
 +
 +<code>
 + cd /path/to/unpackaged/
 +
 +</code>
 +
 +Now install dependencies for the bot:
 +
 +Fedora/AlmaLinux or other RHEL derivatives
 +<code>sudo dnf install npm</code>
 +
 +Debian/Ubuntu or other Debian derivatives
 +<code>sudo apt install npm</code>
 +
 +Install NPM dependencies
 +<code>
 +npm install
 +</code>
 +
 +You will most likely get a message talking about vulnerabilities. You can fix that with:
 +
 +<code>
 +npm audit fix
 +npm fund
 +
 +</code>
 +Install dotenv
 +<code>npm install dotenv</code>
 +
 +Now run the bot with:
 +
 +<code>
 +npm start
 +
 +</code>
 +
 +If you get the following error, it probably means your bot token is incorrect:
 +
 +<code>
 +(node:133979) UnhandledPromiseRejectionWarning: ReferenceError: c is not defined
 +    at /path/to/stickybot/src/main.js:10:15
 +    at processTicksAndRejections (internal/process/task_queues.js:97:5)
 +    at async  /path/to/stickybot/src/src/main.js:9:2
 +
 +</code>
 +
 +Check your .env file and make sure the correct token is in the file. \\  \\ **Now you should see your bot online in your server and ready to send messages!** \\ {{:laptopwiki:guides:discord:stickybot_bot_online.png?200}}
 +
 +===== Messages.json =====
 +
 +In the bot folder is a file messages.json. The bot takes messages from this file and prints them into a Discord message. These messages can be edited while the bot is running. \\  \\ Copy the following template to your messages.json:
 +
 +<code>
 +{
 +    "928291939244195882": "This is a text field",
 +    "comment": "Test channel"
 +}
 +
 +</code>
 +
 +The number on the first line is the channel ID. You can get it by activating developer mode in the Discord Client, right clicking on a channel and selecting Copy ID. \\ You can find that toggle in Discord Settings - Advanced - Developer Mode
 +
 +After the channel ID comes the text. This can have basic formatting like bold and code block:
 +
 +<code>
 +{
 +    "928291939244195882": "`This is a text field`",
 +    "comment": "Test channel"
 +}
 +
 +</code>
 +
 +{{:laptopwiki:guides:discord:stickybot_codeblock.png?200}} \\  \\ The comment line is just for you to say what channel belongs that message to. \\  \\ If you want to add another message to a different channel just replicate this syntax, but add a , at the end of a line:
 +
 +<code>
 +{
 +    "928291939244195882": "`This is a text field`",
 +    "comment": "Test channel",
 +    "928291939244195883": "`This is a text field 2`",
 +    "comment": "Test channel 2"
 +}
 +
 +</code>
 +
 +Do not add , to the very last line, that won't work.
 +
 +===== Run stickybot in the background manually =====
 +
 +Unless you want to keep the SSH connection active all the time to keep the bot running you will need to run it in the background. To do that we will use a Linux terminal application called [[https://www.gnu.org/software/screen/|Screen]] \\
 + \\
 +To install it run:
 +<code>
 +
 +sudo apt install screen
 +
 +</code>
 +
 +Then create a session with:
 +
 +<code>
 +screen -S stickybot
 +
 +</code>
 +
 +Now you are in a Screen session. Now you can start the bot:
 +
 +<code>
 +npm start
 +
 +</code>
 +
 +To properly exit it press CTRL+A and then D. To get back into the session (or Attach it) use:
 +
 +<code>
 +screen -r session-name
 +
 +</code>
 +
 +=== Basic GNU Screen commands ===
 +
 +Create a session:
 +
 +<code>
 +screen -S stickybot
 +
 +</code>
 +
 +List all sessions:
 +
 +<code>
 +screen -ls
 +
 +</code>
 +
 +Kill a particular session :
 +
 +<code>
 +screen -XS sessionid/name quit
 +
 +</code>
 +
 +Kill all Screen sessions:
 +
 +<code>
 +pkill screen
 +
 +</code>
 +
 +===== Running Stickybot as a systemd service =====
 +
 +[[:laptopwiki:guides:os:linux:npmsystemdservice|]]
 +
 +— //[[:laptopwiki:staff:index|dustojnikhummer]] 2022/12/30 08:01//
 +