Documentation and description update

Added .env.example file.
Branch now ready to be merged for the first tagged release of the Bot.

COMMANDS.md

@@ -71,6 +71,12 @@ These commands are locked until there is at least one game configured.
 | `/player leave` | Removes the user issuing the command from the game they are in. This command `must be issued in a text channel associated with the game you are trying to leave`. |
 | `/player remove <@player>` | Removes the user mentioned from the game. This command `must be issued in a text channel associated with the game you are trying to leave`. |
 
+While this is not strictly a `/player` command, and it is housed in a separate cog, it has the same level of permissions and prerequisites as all the `/player` commands.
+
+| Command | Description |
+|---|---|
+|`/tcard`| Invokes a T-Card in the game. This command also posts a graphic of the T-Card, tags the game's role, and pings a message in the appropriate voice channel.|
+
 ### Pitch Command
 
 The `/pitch` command is used to run pitches for games on the server.

README.md

@@ -17,10 +17,26 @@ It no longer uses a database engine because it never really benefitted from the
 The bot authenticates using an API key, which I have kept private in a `.env` file that I have not uploaded to the repository.
 In order to set up your own instance of the bot, you will need to provide the following values in a `.env` file in the root directory.
 
-You will also need this database to set up a username and password for the MongoDB database.
-The specific username and password don't matter as the bot refers back to the environment variable when authenticating.
+The following is a step-by-step guide on installation:
+
+### Prerequisites
+
+1. **Prerequisites**:
+   1. Command line access to your computer.
+   2. Make sure that the Bot has the correct authorisation scopes in your Discord Developer section. The bot needs to have `application.commands` and `bot` enabled.
+   3. Invite the Bot to join your guild.
+   4. Install and run [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git), [Docker](https://docs.docker.com/get-docker/), and [Docker Compose](https://docs.docker.com/compose/install/).
+2. Make a folder to house the project. `mkdir geas-bot && cd geas-bot`
+3. Clone the repository. Type `git clone https://git.vsnt.uk/viveksantayana/geas-bot.git .`
+4. Navigate to the `app` folder and use the `.env.example` file to make the environment variables file: `sudo mv .env.example .env`
+5. Edit the `.env` file and add the relevant API keys (see below). You can do this using any text editor, like `sudo nano .env`.
+6. Place any data files from a previous install in the relevant `/app/data` folder. They will be copied in to the Docker container in the next step. Make sure the `.env` files refer to them correctly.
+7. Navigate back to the root folder `geas-bot` and execute docker-compose to spin up the Bot. Do this in detached mode so you do not get locked into the terminal (unless you want to debug and read the console outputs.) `sudo docker-compose up -d`
+8. Sign in to Discord and finish configuring the bot using the various `/config` commands.
+
+The following is the template for the `.env` file, with the variable names as are referenced in the bot's code.
+You can find an example template of this in the `.env.example` file.
 
-The following is the template for the `.env` file, with the variable names as are referenced in the bot's code:
 `.env` file:
 
 ```DotENV
@@ -37,8 +53,7 @@ BOT_VERSION=(verson string)
 
 The correct API keys need to be entered in the environment variables in the `.env` file, and for a copy of this file to be placed in the root and the `app` directories.
 
-**N.B.**: When the bot is first run, it is configured to log in as the Test Bot, and not the main Geas Server Bot, as a safety measure.
-To change this, navigate to the last line of the file `bot.py` and change the line:
+**N.B.**: You can switch between which Both the code executes, the main bot or the test bot, by changing the variable referenced in the `client.run()` command in the `bot.py` file:
 
 ```py
 client.run(os.getenv('TEST_TOKEN'))
@@ -56,7 +71,9 @@ in order for to authenticate as the correct bot.
 
 ```
 |-- app
-|   |-- .env
+|   |-- .env.example
+|   |-- assets
+|   |   `-- tcard.wav
 |   |-- bot.py
 |   |-- cogs
 |   |   |-- botcommands
@@ -88,7 +105,8 @@ in order for to authenticate as the correct bot.
 |   |           |-- game_management.py
 |   |           |-- manipulate_timeslots.py
 |   |           |-- pitch.py
-|   |           `-- player_commands.py
+|   |           |-- player_commands.py
+|   |           `-- tcard.py
 |   |-- data
 |   |   |-- .gitkeep
 |   |   |-- categories.yml
@@ -114,7 +132,7 @@ The `COMMANDS.md` file gives a list of all the commands the Bot uses, as well as
 
 The bot holds data in two `.yml` files, `config.yml` for client configurations for each guild it is in and `data.yml` to hold the actual data regarding game and channel set-up.
 I was considering merging them into one file, but given how different the two concerns were I ended up splitting the files.
-I had initially condsiders a `.ini` file for the configuration settings and `.json` for the data, but I decided to use `.yml` for both just to avoid unnecessary complexity.
+I had initially considered a `.ini` file for the configuration settings and `.json` for the data, but I decided to use `.yml` for both just to avoid unnecessary complexity.
 
 ### `config.yml` Structure
 

app/.env.example

@@ -0,0 +1,9 @@
+BOT_TOKEN=
+TEST_TOKEN=
+CONFIG=./data/config.yml
+DATA=./data/data.yml
+LOOKUP=./data/lookup.yml
+GM=./data/gm.yml
+CATEGORIES=./data/categories.yml
+PITCHES=./data/pitches.yml
+BOT_VERSION=3.0.0

app/Dockerfile

@@ -1,4 +1,5 @@
 FROM python:3.9.6-buster
+RUN apt-get update -y && apt-get upgrade -y && apt-get install libopus0 -y
 COPY . /usr/src/app
 WORKDIR /usr/src/app
 RUN pip install --upgrade pip

app/bot.py

@@ -75,7 +75,8 @@ def getPrefix(client, message):
 # Define Clients
 client = commands.Bot(
 	intents=discord.Intents.all(),
-	command_prefix=getPrefix
+	command_prefix=getPrefix,
+	description=f'Geas Server Bot v.{os.getenv("BOT_VERSION")}.\n\nThis bot designed to automate the management of key features of the Geas Discord Server. It is written by Vivek Santayana. You can find the source code at https://git.vsnt.uk/viveksantayana/geas-bot.'
 )
 slash = SlashCommand(
 	client,

app/cogs/events/secondary/pitch_listener.py

@@ -66,13 +66,14 @@ class PitchListener(commands.Cog, name='Pitch Listener'):
 				if set([x.id for x in ctx.author.roles]) & set(pitches[guildStr][timeslot]['roles'].values()):
 					for r in list(set([x.id for x in ctx.author.roles]) & set(pitches[guildStr][timeslot]['roles'].values())):
 						role = ctx.guild.get_role(r)
+						rStr = str(role.id)
 						if role.id != pitches[guildStr][timeslot]['roles'][index]:
 							await ctx.author.remove_roles(role,reason=f'/pitch interaction by {ctx.author.display_name}')
 							i = pitches[guildStr][timeslot]['indices'][role.id]
 							element = pitches[guildStr][timeslot]['entries'][i]
 							gm = await self.client.fetch_user(element['gm'])
-							if ctx.author.id != lookup[guildStr][str(role.id)]['gm']:
-								data[guildStr][timeslot][str(role.id)]['current_players'] -= 1
+							if ctx.author.id != lookup[guildStr][rStr]['gm']:
+								data[guildStr][timeslot][rStr]['current_players'] -= 1
 								element['current_players'] -= 1
 							o = f'_ _\n***{element["game_title"]}*** (GM: {gm.mention})\n```\n'
 							if element['system'] is not None: o = ''.join([o,f'System: {element["system"]}\n'])
@@ -84,9 +85,9 @@ class PitchListener(commands.Cog, name='Pitch Listener'):
 							o = ''.join([o,f'~~Spaces Remaining: {str(0)}~~'])if spaces_remaining <= 0 else ''.join([o,f'Spaces Remaining: {str(spaces_remaining)}'])
 							m = await ctx.channel.fetch_message(pitches[guildStr][timeslot]['messages'][i])
 							await m.edit(content=o)
-							tc = discord.utils.find(lambda x: x.id == lookup[guildStr][str(role.id)]['text_channel'],ctx.guild.text_channels)
+							tc = discord.utils.find(lambda x: x.id == lookup[guildStr][rStr]['text_channel'],ctx.guild.text_channels)
 							if tc is None:
-								c = discord.utils.find(lambda x: x.id == lookup[guildStr][str(role.id)]['category'],ctx.guild.categories)
+								c = discord.utils.find(lambda x: x.id == lookup[guildStr][rStr]['category'],ctx.guild.categories)
 								if c is not None:
 									tPos = len(ctx.guild.channels)
 									for t in c.text_channels:
@@ -96,13 +97,15 @@ class PitchListener(commands.Cog, name='Pitch Listener'):
 							if tc is not None:
 								await tc.send(f'```{ctx.author.display_name} has left the game.```')
 				role = ctx.guild.get_role(pitches[guildStr][timeslot]['roles'][index])
+				rStr = str(role.id)
 				if role in ctx.author.roles:
-					await ctx.send(f'```Error: You are already in the game `{lookup[guildStr][str(role.id)]["game_title"]}`.```', hidden=True)
+					await ctx.send(f'```Error: You are already in the game `{lookup[guildStr][rStr]["game_title"]}`.```', hidden=True)
 				else:
 					await ctx.author.add_roles(role,reason=f'/pitch interaction by {ctx.author.display_name}')
 					element = pitches[guildStr][timeslot]['entries'][index]
-					data[guildStr][timeslot][str(role.id)]['current_players'] += 1
-					element['current_players'] += 1
+					if ctx.author.id != lookup[guildStr][rStr]['gm']:
+						data[guildStr][timeslot][rStr]['current_players'] += 1
+						element['current_players'] += 1
 					gm = await self.client.fetch_user(element['gm'])
 					o = f'_ _\n***{element["game_title"]}*** (GM: {gm.mention})\n```\n'
 					if element['system'] is not None: o = ''.join([o,f'System: {element["system"]}\n'])
@@ -114,10 +117,10 @@ class PitchListener(commands.Cog, name='Pitch Listener'):
 					o = ''.join([o,f'~~Spaces Remaining: {str(0)}~~'])if spaces_remaining <= 0 else ''.join([o,f'Spaces Remaining: {str(spaces_remaining)}'])
 					m = await ctx.channel.fetch_message(pitches[guildStr][timeslot]['messages'][index])
 					await m.edit(content=o)
-					await ctx.send(f'You have joined the game `{lookup[guildStr][str(role.id)]["game_title"]}`.',hidden=True)
-					tc = discord.utils.find(lambda x: x.id == lookup[guildStr][str(role.id)]['text_channel'],ctx.guild.text_channels)
+					await ctx.send(f'You have joined the game `{lookup[guildStr][rStr]["game_title"]}`.',hidden=True)
+					tc = discord.utils.find(lambda x: x.id == lookup[guildStr][rStr]['text_channel'],ctx.guild.text_channels)
 					if tc is None:
-						c = discord.utils.find(lambda x: x.id == lookup[guildStr][str(role.id)]['category'],ctx.guild.categories)
+						c = discord.utils.find(lambda x: x.id == lookup[guildStr][rStr]['category'],ctx.guild.categories)
 						if c is not None:
 							tPos = len(ctx.guild.channels)
 							for t in c.text_channels:
@@ -126,15 +129,27 @@ class PitchListener(commands.Cog, name='Pitch Listener'):
 									tPos = t.position
 					if tc is not None:
 						await tc.send(f'```{ctx.author.display_name} has joined the game.```')
+						ts = lookup[guildStr][rStr]['time']
+						p = await tc.pins()
+						if p is not None:
+							header = discord.utils.find(lambda x: x.id == data[guildStr][ts][rStr]['header_message'], p)
+							if header is not None:
+								text = header.content.split('\n')
+								for line, item in enumerate(text):
+									if 'Current Players: ' in item:
+										text[line] = f'Current Players: {str(data[guildStr][ts][rStr]["current_players"]) if data[guildStr][ts][rStr]["current_players"] is not None else str(0)}'
+										break
+								await header.edit(content='\n'.join(text))
 			elif ctx.custom_id.startswith('leave_'):
 				role = ctx.guild.get_role(pitches[guildStr][timeslot]['roles'][index])
+				rStr = str(role.id)
 				if role not in ctx.author.roles:
-					await ctx.send(f'```Error: You are not in the game `{lookup[guildStr][str(role.id)]["game_title"]}`.```', hidden=True)
+					await ctx.send(f'```Error: You are not in the game `{lookup[guildStr][rStr]["game_title"]}`.```', hidden=True)
 				else:
 					await ctx.author.remove_roles(role,reason=f'/pitch interaction by {ctx.author.display_name}')
 					element = pitches[guildStr][timeslot]['entries'][index]
-					if ctx.author.id != lookup[guildStr][str(role.id)]['gm']:
-						data[guildStr][timeslot][str(role.id)]['current_players'] -= 1
+					if ctx.author.id != lookup[guildStr][rStr]['gm']:
+						data[guildStr][timeslot][rStr]['current_players'] -= 1
 						element['current_players'] -= 1
 					gm = await self.client.fetch_user(element['gm'])
 					o = f'_ _\n***{element["game_title"]}*** (GM: {gm.mention})\n```\n'
@@ -147,10 +162,10 @@ class PitchListener(commands.Cog, name='Pitch Listener'):
 					o = ''.join([o,f'~~Spaces Remaining: {str(0)}~~'])if spaces_remaining <= 0 else ''.join([o,f'Spaces Remaining: {str(spaces_remaining)}'])
 					me = await ctx.channel.fetch_message(pitches[guildStr][timeslot]['messages'][index])
 					await me.edit(content=o)
-					await ctx.send(f'You have left the game `{lookup[guildStr][str(role.id)]["game_title"]}`.',hidden=True)
-					tc = discord.utils.find(lambda x: x.id == lookup[guildStr][str(role.id)]['text_channel'],ctx.guild.text_channels)
+					await ctx.send(f'You have left the game `{lookup[guildStr][rStr]["game_title"]}`.',hidden=True)
+					tc = discord.utils.find(lambda x: x.id == lookup[guildStr][rStr]['text_channel'],ctx.guild.text_channels)
 					if tc is None:
-						c = discord.utils.find(lambda x: x.id == lookup[guildStr][str(role.id)]['category'],ctx.guild.categories)
+						c = discord.utils.find(lambda x: x.id == lookup[guildStr][rStr]['category'],ctx.guild.categories)
 						if c is not None:
 							tPos = len(ctx.guild.channels)
 							for t in c.text_channels:
@@ -159,6 +174,17 @@ class PitchListener(commands.Cog, name='Pitch Listener'):
 									tPos = t.position
 					if tc is not None:
 						await tc.send(f'```{ctx.author.display_name} has left the game.```')
+						ts = lookup[guildStr][rStr]['time']
+						p = await tc.pins()
+						if p is not None:
+							header = discord.utils.find(lambda x: x.id == data[guildStr][ts][rStr]['header_message'], p)
+							if header is not None:
+								text = header.content.split('\n')
+								for line, item in enumerate(text):
+									if 'Current Players: ' in item:
+										text[line] = f'Current Players: {str(data[guildStr][ts][rStr]["current_players"]) if data[guildStr][ts][rStr]["current_players"] is not None else str(0)}'
+										break
+								await header.edit(content='\n'.join(text))
 		yaml_dump(data, dataFile)
 		yaml_dump(pitches, pitchesFile)
 

app/cogs/membership/member_verification.py

@@ -27,14 +27,14 @@ class MemberVerification(commands.Cog, name='Member Verification Cog'):
 		if message.author.bot: return
 		if message.channel.id != conf[guildStr]['channels']['signup']: return
 		if not (message.attachments):
-			await message.channel.send(f'```Error: The message you posted in the `{message.channel.name}` channel of the guild `{message.guild.name}` was invalid. Your post must contain a screensot of your proof of purchase for membership.```')
+			await message.author.send(f'```Error: The message you posted in the `{message.channel.name}` channel of the guild `{message.guild.name}` was invalid. Your post must contain a screensot of your proof of purchase for membership.```')
 			await message.delete()
 			return
 		membership = [discord.utils.get(message.guild.roles, id=x) for x in conf[guildStr]['membership']]
 		membership_options = [create_select_option(label=x.name, value=str(x.id), description='Membership type.') for x in membership]
 		admin_buttons = []
 		if conf[guildStr]['roles'].get('student', None) is not None: admin_buttons.append(create_button(style=ButtonStyle.blurple, label='Student', emoji='📚', custom_id=f'student_{message.id}'))
-		admin_buttons.append(create_button(style=ButtonStyle.grey, label='Alert', emoji='⚠️', custom_id=f'alert_{message.id}'))
+		admin_buttons.append(create_button(style=ButtonStyle.grey, label='Review', emoji='⚠️', custom_id=f'review_{message.id}'))
 		admin_buttons.append(create_button(style=ButtonStyle.red, label='Deny', emoji='✖️', custom_id=f'deny_{message.id}'))
 		admin_buttons.append(create_button(style=ButtonStyle.green, label='Done', emoji='▶️', custom_id=f'done_{message.id}'))
 		o = f'```For Administrators: Please verify the membership request submitted by `{message.author.display_name}`.```'
@@ -89,36 +89,36 @@ class MemberVerification(commands.Cog, name='Member Verification Cog'):
 					description = f'[Jup to Message]({submission.jump_url})',
 					colour = discord.Colour.red(),
 				)
-				await submission.channel.send(f'```Your membership for guild `{submission.guild.name}` could not be verified. Please make sure your name and the kind of membership that you have bought are visible in the screenshot you upload. Please contact a Committee member if you have any difficulties.```')
+				await submission.author.send(f'```Your membership for guild `{submission.guild.name}` could not be verified. Please make sure your name and the kind of membership that you have bought are visible in the screenshot you upload. Please contact a Committee member if you have any difficulties.```')
 				if conf[guildStr]['channels'].get('mod', None) is not None:
 					await submission.guild.get_channel(conf[guildStr]['channels']['mod']).send(f'```Verifying the membership of {submission.author.display_name} failed.```\n{admins}', embed=embed)
 				await ctx.origin_message.delete()
-			elif ctx.custom_id.startswith('alert_'):
-				await ctx.send(f'```Membership verification alert raised.```', hidden=True)
+			elif ctx.custom_id.startswith('review_'):
+				await ctx.send(f'```Membership review requested.```', hidden=True)
 				embed = discord.Embed(
 					title = submission.author.name,
 					description = f'[Jup to Message]({submission.jump_url})',
 					colour = discord.Colour.orange()
 				)
-				await submission.channel.send(f'```Your membership for guild `{submission.guild.name}` needs to be reviewed by a Committee member.```')
+				await submission.author.send(f'```Your membership for guild `{submission.guild.name}` needs to be reviewed by a Committee member.```')
 				if conf[guildStr]['channels'].get('mod', None) is not None:
 					await submission.guild.get_channel(conf[guildStr]['channels']['mod']).send(f'```There is a problem verifying the membership of {submission.author.display_name}.\nCould someone verify this person\'s membership manually via the EUSA portal?.```\n{admins}', embed=embed)
 			elif ctx.custom_id.startswith('student_'):
 				await ctx.send(f'````Student` role granted.```', hidden=True)
 				student_role = submission.guild.get_role(conf[guildStr]['roles']['student'])
 				await submission.author.add_roles(student_role, reason=f'Membership Verification: Student role assigned by `{ctx.author.display_name}`.')
-				await submission.channel.send(f'```You have additionally been assigned the role `Student` in the guild `{submission.guild.name}`.```')
+				await submission.author.send(f'```You have additionally been assigned the role `Student` in the guild `{submission.guild.name}`.```')
 			elif ctx.custom_id.startswith('membership_'):
 				[selected_membership] = ctx.selected_options
 				selected_role = ctx.guild.get_role(int(selected_membership))
 				if selected_role not in submission.author.roles:
 					await ctx.send(f'```Membership `{selected_role.name}` added to member `{submission.author.display_name}`.```', hidden=True)
 					await submission.author.add_roles(selected_role, reason=f'Membership Verification: Membership verified by `{ctx.author.display_name}`.')
-					await submission.channel.send(f'```Your membership for guild `{submission.guild.name}` has been verified and you have been assigned the role `{selected_role.name}`.```')
+					await submission.author.send(f'```Your membership for guild `{submission.guild.name}` has been verified and you have been assigned the role `{selected_role.name}`.```')
 				else:
 					await ctx.send(f'```Membership `{selected_role.name}` removed from member `{submission.author.display_name}`.```', hidden=True)
 					await submission.author.remove_roles(selected_role, reason=f'Membership Verification: Membership removed by `{ctx.author.display_name}`.')
-					await submission.channel.send(f'```Your role `{selected_role.name}` has been removed in the guild `{submission.guild.name}`.```')
+					await submission.author.send(f'```Your role `{selected_role.name}` has been removed in the guild `{submission.guild.name}`.```')
 			else:
 				pass
 

app/cogs/slashcommands/secondary/player_commands.py

@@ -148,7 +148,7 @@ class PlayerCommands(commands.Cog, name='Player Commands'):
 		tc = discord.utils.find(lambda x: x.id == lookup[guildStr][rStr]['text_channel'],ctx.guild.channels)
 		if tc is not None:
 			p = await tc.pins()
-			if p:
+			if p is not None:
 				header = discord.utils.find(lambda x: x.id == hm, p)
 				if header is not None:
 					text = header.content.split('\n')
@@ -211,7 +211,7 @@ class PlayerCommands(commands.Cog, name='Player Commands'):
 		tc = discord.utils.find(lambda x: x.id == lookup[guildStr][rStr]['text_channel'],ctx.guild.channels)
 		if tc is not None:
 			p = await tc.pins()
-			if p:
+			if p is not None:
 				header = discord.utils.find(lambda x: x.id == hm, p)
 				if header is not None:
 					text = header.content.split('\n')

app/cogs/slashcommands/secondary/tcard.py

@@ -37,7 +37,6 @@ class TCardCommand(commands.Cog, name='T-Card Command'):
 		gms = yaml_load(gmFile)
 		categories = yaml_load(categoriesFile)
 		guildStr = str(ctx.guild.id)
-		# rStr = str(game.id)
 		embed = discord.Embed(
 			title='T-Card',
 			description='A T-Card Has Been Played',
@@ -68,12 +67,10 @@ class TCardCommand(commands.Cog, name='T-Card Command'):
 				await ctx.send(content=f'```You have invoked the T-Card in the game {lookup[guildStr][str(role.id)]["game_title"]}. The GM has been notified privately.```', hidden=True)
 			
 			"""Do the audio thing."""
-			discord.opus.load_opus()
-			if not discord.opus.is_loaded():
-				raise RuntimeError('Opus failed to load')
+			opus = discord.opus.load_opus('/usr/lib/x86_64-linux-gnu/libopus.so.0')
 			for vc in ctx.channel.category.voice_channels:
 				v = await vc.connect()
-				tcardaudio = discord.FFmpegPCMAudio(open("./assets/tcard.wav", "rb"))
+				tcardaudio = discord.PCMAudio(open("./assets/tcard.wav", "rb"))
 				v.play(tcardaudio)
 				while v.is_playing(): time.sleep(.1)
 				await v.disconnect()