Skip to content

Commit

Permalink
README fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
eriknyquist committed Sep 19, 2021
1 parent b4881b8 commit f541f5f
Showing 1 changed file with 22 additions and 14 deletions.
36 changes: 22 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ twitch_monitor_discord_bot

This is a discord bot which will periodically check a list of twitch streamers,
and post an announcement on a specific discord channel when a streamer goes live.
It also does some other silly/fun things.

Install
=======
Expand All @@ -16,8 +17,11 @@ Install for Python3 using ``pip``:
Quick start
===========

Initial configuration
---------------------

#. Run the package as a module with no arguments, which will create an empty configuration
file called ```default_bot_config.json``` in your current directory and exit immediately.
file called ``default_bot_config.json`` in your current directory and exit immediately.

::

Expand All @@ -30,28 +34,28 @@ Quick start
bot is up and running, but there are a few parameters that need to be set in the configuration
file first, to get the bot talking. Populate these required parameters in the .json file:

#. ```twitch_client_id```: Twitch client ID must be entered here as an integer.
#. ``twitch_client_id``: Twitch client ID must be entered here as an integer.
You must have a twitch account, and register an application to obtain a twitch client ID.
`instructions here<https://dev.twitch.tv/docs/api/#step-1-register-an-application>`_.
`instructions here <https://dev.twitch.tv/docs/api/#step-1-register-an-application>`_.

#. ```discord_bot_api_token```: Discord bot API token must be entered here as a string.
`Create a new bot application, and generate/copy token on the "Bot" page<https://discord.com/developers/applications>`_
#. ``discord_bot_api_token``: Discord bot API token must be entered here as a string.
`Create a new bot application, and generate/copy token on the "Bot" page <https://discord.com/developers/applications>`_

#. ```discord_server_id```: Discord server ID (the server that you want the bot to
#. ``discord_server_id``: Discord server ID (the server that you want the bot to
connect to) must be entered here as an integer.
`How to find discord user/server/message IDs<https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID->`_
`How to find discord user/server/message IDs <https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID->`_

#. ```discord_server_channel_name```: Discord channel name (the channel within the discord
#. ``discord_server_channel_name``: Discord channel name (the channel within the discord
server where the bot should post updates about twitch streamers that are being monitored)
must be entered here as a string.

#. ```discord_admin_users```: A list of discord user IDs as integers may be entered here.
#. ``discord_admin_users``: A list of discord user IDs as integers may be entered here.
Admin users have access to the full set of discord commands that the bot can accept.
At the very least, you'll probably want to add your own discord user ID here so that
you have full control of the bot.
`How to find discord user/server/message IDs<https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID->`_
`How to find discord user/server/message IDs <https://support.discord.com/hc/en-us/articles/206346498-Where-can-I-find-my-User-Server-Message-ID->`_

#. ```host_streamer```: If you are a streamer yourself, enter your twitch name here as a string,
#. ``host_streamer``: If you are a streamer yourself, enter your twitch name here as a string,
so that the bot can avoid posting notifications about other streamers when you are live.
(NOTE: this is optional, you may set this to null or an empty string if desired)

Expand All @@ -66,14 +70,18 @@ Quick start
If configured correctly, then the bot should now connect to your discord server.

Interacting with the bot on discord
===================================
-----------------------------------

Whenever your bot is online in the discord server, you can issue commands to the bot
by putting a mention of the bot's discord name at the beginning of the messagem, e.g.
```@BotName !command```. The only command you really need to know is the ```help``` command;
if you say ```@BotName !help```, then the bot will show you what commands are available
and show you how to get help with individual commands.

The first thing you'll probably want to do is add some twitch streamers to monitor--
there's a command for that! Try ``@BotName !help addstreamers`` to learn how to do that.


Configuration file details
==========================

Expand Down Expand Up @@ -105,7 +113,7 @@ in the Quick Start section. The configuration file must be a .json file of the f
}

Description of fields
#####################
---------------------

* ``twitch_client_id``: Enter your Twitch client ID here.

Expand All @@ -125,7 +133,7 @@ Description of fields
here will be allowed to configure the bot by sending commands in discord.

* ``command_log_file``: Enter desired filename to log commands received from discord messages.
Set to "null" if you don't want to log commands.
Set to "null" if you don't want to log commands.

* ``config_write_delay_seconds``: Enter the desired cooldown time (in seconds) for commands that
write changes to the bot config file here (makes it more difficult for someone with admin privileges to spam the disk).
Expand Down

0 comments on commit f541f5f

Please sign in to comment.