How do you run this?

[Capitanpingaloca]

Please help out a noob.

I've installed the requirements.

But can't figure out how to run the framework.

[davidhozic]

First you need python installed https://www.python.org/downloads/.
Then you need install via python -m pip install discord-advert-framework

After you create a python script (text file that ends with .py)
And in that file you need to define the server list and then start the framework with framework.run
To run the script you use python your_script.py.
Basic example

---

If you want to find channels automatically, you can use the following code in your .py script.
You can change data_to_shill to change what is sent, allowed_strings are any of the strings that can be inside the channel name for it to be used.
You also need to change the token inside the fw.run at the end of the following example (and set is_user to True if you're not using a bot account)

"""
~ Example file ~
This file shows how you can make a script that automatically generates the server
list based on the `allowed_strings` list (contains strings that must appear in the channel name we want to shill into).

We pass the framework a user_callback function named `find_advertisement_channels` which autofills the `servers` list with GUILD objects.
"""
import framework as fw


# Create a list in which we will automatically add guilds
allowed_strings = {"shill", "advert", "promo"}
data_to_shill = (     # Example data set
                "Hello World", 
                fw.EMBED(title="Example Embed",
                         color=fw.EMBED.Color.blue(),
                         description="This is a test embed")
                )


servers = []

async def find_advertisement_channels():
    # Returns the client to send commands to discord, for more info about client see https://docs.pycord.dev/en/master/api.html?highlight=discord%20client#discord.Client
    client = fw.get_client()  
    
    for guild in client.guilds:  # Iterate thru all the guilds where the bot is in
        channels = []
        for i, channel in enumerate(guild.text_channels): # Iterate thru all the text channels in the guild
            if any([x in channel.name for x in allowed_strings]): # Check if any of the strings in allowed_strings are in the channel name
                channels.append(channel.id) # If so, add the channel id to the list
        
        # Add the guild to the internal shilling list
        if len(channels):
            await fw.core.add_object(   
                fw.GUILD(
                    guild.id,                               # Guild id
                    [                                       # List of messages
                        fw.TextMESSAGE(None,                    # Start period
                                    5,                       # End period
                                    data_to_shill,           # Data that will be sent
                                    channels,                # List of channels to send the message to            
                                    "send",                  # Sending moode (send, edit, clear-send)
                                    True                     # Should the message be sent immediately after adding it to the list
                        )                                   
                    ],
                    True                                    # Should the framework generate a log of sent messages for this guild
                )
            )


fw.run(
    token="OSDSJ44JNnnJNJ2NJDBWQUGHSHFAJSHDUQHFDBADVAHJVERAHGDVAHJSVDE",   # Example token
    server_list=servers,
    is_user=True,
    user_callback=find_advertisement_channels
)

[Capitanpingaloca]

A million thank you's.

This should clear everything up.