Skip to content

Home

Jump to bottom
Max Bridgland edited this page Jan 11, 2020 · 10 revisions

Table of Contents

  • Home
  • Plugin Packs
  • Listeners
  • Custom Plugins

Slacky

The First Python Selfbot for Slack Workspaces

What is this?

Slacky was created as way to automate and make Slack more fun to use. It comes with many commands by default and even allows for custom plugins to be built and imported easily.

Slack as far as I can see have no rules against using selfbots so the only people who would probably find this annoying/against policy would be your organizer admistrators.

Slack Client


Bot Server


Getting Started:

Requirements:

  • Python 3
  • Slack
  • Internet Connection
  • Server or Herokuapp Knowledge for Always on Bot

Installing:

From Source

git clone https://github.com/M4cs/Slacky
cd Slacky/
pip3 install -r requirements.txt
python3 -m slacky

Using Docker (Much Easier Solution IMO)

# Run once to setup Config
python3 -m slacky
# Run again using Docker
docker-compose up --build

Configuration Setup:

The bot reads from a config file. This config file will be generated through the wizard if you have not already made one. Below are links for grabbing the information needed for the config:

Default Prefix (Use ~setprefix or set in config on startup to change): ~

Get your legacy token for the bot: https://api.slack.com/custom-integrations/legacy-tokens

Get your User ID:

Creating Custom Plugins:

Creating custom commands and plugins are easy for Slacky. All plugins are written in Python and you can see an example for yourself in slacky/plugins/custom/example.py. To create your own plugin follow these steps:

First, create a file in slacky/plugins/custom/ with the name of your plugin. This file can hold one or multiple commands, you can also use a folder but that will get more complicated for imports. We will call this file plugin.py for now. In this plugin.py you will want to follow the format of the current example in the repo for obtaining msg and channel data. Below is the example plugin available already:

Building Your New Plugin:

from slacky import client, config, Prefixes
from slack.errors import SlackApiError

def custom_example(**payload):
    # Get Data from Payload
    data = payload['data']
    channel_id = data['channel'] # Get Channel ID
    user = data.get('user') # Get User
    timestamp = data['ts'] # Get msg Timestamp
    if check_user(user): # Check if User == You
        web_client = client # Init Client
        text = data.get('text') # Get Text
        # Check for Command Here
        if text:
            text_split = text.split(' ')
            cmd = text_split[0]
            if cmd == config['prefix'] + 'example':
                # Command has been triggered
                print(Prefixes.event + 'Ran Command: example')
                # Do your logic here and then update the message at the end below.
                try:
                    web_client.chat_update(
                        channel=channel_id,
                        ts=timestamp,
                        text="This command is an example custom command."
                    )
                except SlackApiError as e:
                    print(Prefixes.error + str(e))

This plugin simply updates your message to say "This command is an example custom command."

Installing Your New Plugin:

Go to slacky/plugins/custom/__init__.py and import your plugin(s) inside of it. If you have a plugin inside a file called plugin.py you can import it with from .plugin import *. This will allow the main plugin fil*e to automatically import your commands.

Now you have to register your command with your RTMClient. To do so go into slacky/__main__.py and go to the bottom where you see the example plugin loaded. You can then register your plugin with something like this:

# Function name of command: custom_plugin

@slack.RTMClient.run_on(event='message')
def _custom_plugin(**payload):
    return custom_plugin(**payload)

Now restart the bot and you will have loaded your custom plugin!

Default Commands

These will be improved over time

Command Description Usage
heartbeat Check if bot is up or not ~heartbeat
info Get info about the bot ~info
ascii Generate ASCII art from a phrase ~ascii msg
shift CrEaTe ShIfT tExT lIkE tHiS ~shift phrase
subspace Replace spaces with emojis ~subspace :emoji: msg
setprefix Sets bot command prefix ~setprefix prefix
xkcd Get Daily xkcd comic ~xkcd
delete Delete X num of your msgs ~delete num_of_msgs
react React to last sent message ~react :emoji:
reactrand React to with random emoji ~reactrand
reactspam Spam 23 Reactions (Notification Spam) ~randspam
howdoi Find code snippets from stack overflow ~howdoi loop over list python
listener Add or remove listeners ~listener add/delete phrase
listener list List all listener words ~listener list
help Display this message ~help

Contributing

Contributions can be done through Pull Requests or by creating a plugin pack.

License

I ask that if you fork this do not release as your own. Please credit and mention it's built off this. In fact building a plugin pack rather than a new bot entirely would be best! The license is MIT so I won't stop you but I'm just asking that you respect my wishes 😄

Clone this wiki locally