geas-bot/TODO.md

# To Do

## Bot Architecture

- [x] Simplify directory tree
- [x] Split event listeners into individual cogs.
- [x] Update with re-organised data and config structure

> - [x] Correct references to data in existing cogs.

- [x] Setup minimally functioning configs of guild on startup
- [x] Synchronise core configuration `/commands` on startup
- [ ] ~~Synchronise secondary `/commands` on complete configuration~~ ``(see below)``

## Bot Functionality and Processes

- [ ] ~~'Delete Commands' Function~~
- [ ] ~~'Register Commands' Function~~
- [x] Infer Permissions from Config
- [x] Dynamic Command Prefixes
- [ ] Infer current games from Server Structure
`Create a separate cog to do this instead of having a migrate command, install the cog temporarily and remove the cog once migration is done.`
- [ ] Re-enable logging
- [x] Delete Dev/Test Functions
- [x] Error handlers
- [x] Debug Features

> - [ ] ~~Command Installer/Uninstaller~~

- [x] Help Channel Event Listener

> - [x] Add Config key for Help Channel

- [ ] ~~Slash Command Buttons or~~ `This kind of got subsumed into other features.`
- [ ] ~~Reaction listener selectors~~ `So did this.`
- [ ] Member Verification

> - [x] Add Config key membership signup channels
> - [x] Add config keys: Membership Category Roles
> - [ ] Message Receive listener
> - [ ] Message React listener or buttons

- [ ] Membership Restriction

> - [ ] Message Receive Listener
> - [ ] Membership Validation Listener

- [ ] Re-synchronise commands after any relevant config changes `(See from above)`

> - [ ] Role Delete (member, admin, game)
> - [ ] Channel delete (notifications, logs, game text channel)
> - [ ] Category delete (games)

- [x] Flag for checking completeness of configuration for a guild.

> - [x] Function for checking configs for completeness

- [ ] Synchronise game channel on role updates

> - [ ] Exception to event listener to prevent circularity `unsure what this means`

## Event Listeners

## Review Configs When

- [x] Guild Changing Ownership
- [x] Roles Modified  
- [x] Mod Channel Deleted

## Commands

- [x] Configure Bot function and sub commands

> - [x] botrole (role group)
> - [x] committeerole (role group)
> - [x] modchannel (channel group)
> - [x] help channel (channel group)
> - [x] signup channel (channel group)
> - [x] newcomer role (role group)
> - [x] returning player role (role group)
> - [x] student role (role group)
> - [x] help notifications (notification group)
> - [x] signup notifications (notification group)

- [x] Set up timeslots
- [x] Delete timeslots

> - [x] Base command
> - [x] ~~Delete all games with the timeslot~~
Do the opposite: block deleting timeslots with existing games.

- [x] List timeslots
- [x] Set up command permissions

> - [x] Slash Commands

>> - [x] Admin Commands
>> - [x] Game Management Commands

> - [x] Native Bot Commands

- [x] Migrate existing bot commands

> - [x] setupgame
> - [x] ~~definebotrole~~ config
> - [x] deletegame
> - [x] ~~reset~~ purge
> - [ ] ~~migrate~~ `See above`
> - [x] ~~kickplayer~~ `/player remove`
> - [x] ~~addplayer~~ `/player add`
> - [x] ~~leavegame~~ `/player leave`
> - [x] Pitch command and sub-commands

> > - [ ] ~~run~~ `Combined both sub-commands into single command and prompt response.`
> > - [ ] ~~clear~~ 

## Misc

- [ ] Review documentation

> - [ ] Finalise README.md
> - [ ] CHANGELOG.md
> - [ ] COMMANDS.md
> - [ ] resources.md

- [ ] Make sure to document `not using discord_components and staying with discord-py-slash-commands library alone`.
15 July Build Implemented YAML Implemented basic client introspection for guild metadata Added todo tracker 2021-07-15 09:03:44 +01:00			`# To Do`

			`## Bot Architecture`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Fixed formatting errors in TODO.md 2021-07-15 23:23:48 +01:00			`- [x] Simplify directory tree`
Fixed more formatting errors 2021-07-15 23:26:53 +01:00			`- [x] Split event listeners into individual cogs.`
Added config checking, event listeners, etc. Can track added features by comparing TODO list. 2021-07-16 23:53:31 +01:00			`- [x] Update with re-organised data and config structure`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Added config checking, event listeners, etc. Can track added features by comparing TODO list. 2021-07-16 23:53:31 +01:00			`> - [x] Correct references to data in existing cogs.`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Started writing /commands. Completed channel group of config subcommands Fixed bugs in config initialisation function 2021-07-17 13:56:04 +01:00			`- [x] Setup minimally functioning configs of guild on startup`
			- [x] Synchronise core configuration `/commands` on startup
Finished writing Pitch command. Needs further testing. Prepare to write member verification and event listeners next. 2021-07-23 00:44:21 +01:00			- [ ] ~~Synchronise secondary `/commands` on complete configuration~~ ``(see below)``
15 July Build Implemented YAML Implemented basic client introspection for guild metadata Added todo tracker 2021-07-15 09:03:44 +01:00
Started writing /commands. Completed channel group of config subcommands Fixed bugs in config initialisation function 2021-07-17 13:56:04 +01:00			`## Bot Functionality and Processes`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Finished Config command group 2021-07-18 23:16:58 +01:00			`- [ ] ~~'Delete Commands' Function~~`
			`- [ ] ~~'Register Commands' Function~~`
Started writing /commands. Completed channel group of config subcommands Fixed bugs in config initialisation function 2021-07-17 13:56:04 +01:00			`- [x] Infer Permissions from Config`
Added config checking, event listeners, etc. Can track added features by comparing TODO list. 2021-07-16 23:53:31 +01:00			`- [x] Dynamic Command Prefixes`
Wrote player commands, still not tested. 2021-07-21 11:49:29 +01:00			`- [ ] Infer current games from Server Structure`
Finished writing Pitch command. Needs further testing. Prepare to write member verification and event listeners next. 2021-07-23 00:44:21 +01:00			`Create a separate cog to do this instead of having a migrate command, install the cog temporarily and remove the cog once migration is done.`
Fixed more formatting errors 2021-07-15 23:26:53 +01:00			`- [ ] Re-enable logging`
Added config checking, event listeners, etc. Can track added features by comparing TODO list. 2021-07-16 23:53:31 +01:00			`- [x] Delete Dev/Test Functions`
			`- [x] Error handlers`
Fixed the game modift command. Working on purge and GM commands next. 2021-07-20 00:44:03 +01:00			`- [x] Debug Features`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Finished Config command group 2021-07-18 23:16:58 +01:00			`> - [ ] ~~Command Installer/Uninstaller~~`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Added config checking, event listeners, etc. Can track added features by comparing TODO list. 2021-07-16 23:53:31 +01:00			`- [x] Help Channel Event Listener`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Added config checking, event listeners, etc. Can track added features by comparing TODO list. 2021-07-16 23:53:31 +01:00			`> - [x] Add Config key for Help Channel`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Finished writing Pitch command. Needs further testing. Prepare to write member verification and event listeners next. 2021-07-23 00:44:21 +01:00			- [ ] ~~Slash Command Buttons or~~ `This kind of got subsumed into other features.`
			- [ ] ~~Reaction listener selectors~~ `So did this.`
Updated ToDo with more detail 2021-07-15 23:53:37 +01:00			`- [ ] Member Verification`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Added config checking, event listeners, etc. Can track added features by comparing TODO list. 2021-07-16 23:53:31 +01:00			`> - [x] Add Config key membership signup channels`
			`> - [x] Add config keys: Membership Category Roles`
Updated ToDo with more detail 2021-07-15 23:53:37 +01:00			`> - [ ] Message Receive listener`
			`> - [ ] Message React listener or buttons`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Updated ToDo with more detail 2021-07-15 23:53:37 +01:00			`- [ ] Membership Restriction`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Updated ToDo with more detail 2021-07-15 23:53:37 +01:00			`> - [ ] Message Receive Listener`
			`> - [ ] Membership Validation Listener`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Finished writing Pitch command. Needs further testing. Prepare to write member verification and event listeners next. 2021-07-23 00:44:21 +01:00			- [ ] Re-synchronise commands after any relevant config changes `(See from above)`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Wrote player commands, still not tested. 2021-07-21 11:49:29 +01:00			`> - [ ] Role Delete (member, admin, game)`
			`> - [ ] Channel delete (notifications, logs, game text channel)`
			`> - [ ] Category delete (games)`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Added config checking, event listeners, etc. Can track added features by comparing TODO list. 2021-07-16 23:53:31 +01:00			`- [x] Flag for checking completeness of configuration for a guild.`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Added config checking, event listeners, etc. Can track added features by comparing TODO list. 2021-07-16 23:53:31 +01:00			`> - [x] Function for checking configs for completeness`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Wrote player commands, still not tested. 2021-07-21 11:49:29 +01:00			`- [ ] Synchronise game channel on role updates`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Wrote player commands, still not tested. 2021-07-21 11:49:29 +01:00			> - [ ] Exception to event listener to prevent circularity `unsure what this means`
Fixed the game modift command. Working on purge and GM commands next. 2021-07-20 00:44:03 +01:00
15 July Build Implemented YAML Implemented basic client introspection for guild metadata Added todo tracker 2021-07-15 09:03:44 +01:00			`## Event Listeners`

Added config checking, event listeners, etc. Can track added features by comparing TODO list. 2021-07-16 23:53:31 +01:00			`## Review Configs When`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Added config checking, event listeners, etc. Can track added features by comparing TODO list. 2021-07-16 23:53:31 +01:00			`- [x] Guild Changing Ownership`
			`- [x] Roles Modified`
			`- [x] Mod Channel Deleted`
15 July Build Implemented YAML Implemented basic client introspection for guild metadata Added todo tracker 2021-07-15 09:03:44 +01:00
			`## Commands`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Finished /config subcommands Prior to abstraction to generic /config commands with multiple keyed arguments 2021-07-18 00:43:44 +01:00			`- [x] Configure Bot function and sub commands`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Started writing /commands. Completed channel group of config subcommands Fixed bugs in config initialisation function 2021-07-17 13:56:04 +01:00			`> - [x] botrole (role group)`
Finished /config subcommands Prior to abstraction to generic /config commands with multiple keyed arguments 2021-07-18 00:43:44 +01:00			`> - [x] committeerole (role group)`
Started writing /commands. Completed channel group of config subcommands Fixed bugs in config initialisation function 2021-07-17 13:56:04 +01:00			`> - [x] modchannel (channel group)`
			`> - [x] help channel (channel group)`
			`> - [x] signup channel (channel group)`
Finished /config subcommands Prior to abstraction to generic /config commands with multiple keyed arguments 2021-07-18 00:43:44 +01:00			`> - [x] newcomer role (role group)`
			`> - [x] returning player role (role group)`
			`> - [x] student role (role group)`
			`> - [x] help notifications (notification group)`
			`> - [x] signup notifications (notification group)`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Finished Config command group 2021-07-18 23:16:58 +01:00			`- [x] Set up timeslots`
Wrote player commands, still not tested. 2021-07-21 11:49:29 +01:00			`- [x] Delete timeslots`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Wrote Create and Delete Game commands Untested. 2021-07-19 02:26:35 +01:00			`> - [x] Base command`
Wrote player commands, still not tested. 2021-07-21 11:49:29 +01:00			`> - [x] ~~Delete all games with the timeslot~~`
Changed how delete time slot functions 2021-07-20 21:43:22 +01:00			`Do the opposite: block deleting timeslots with existing games.`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Finished Config command group 2021-07-18 23:16:58 +01:00			`- [x] List timeslots`
Wrote player commands, still not tested. 2021-07-21 11:49:29 +01:00			`- [x] Set up command permissions`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Wrote player commands, still not tested. 2021-07-21 11:49:29 +01:00			`> - [x] Slash Commands`
Finished writing Pitch command. Needs further testing. Prepare to write member verification and event listeners next. 2021-07-23 00:44:21 +01:00
Started writing /commands. Completed channel group of config subcommands Fixed bugs in config initialisation function 2021-07-17 13:56:04 +01:00			`>> - [x] Admin Commands`
Wrote player commands, still not tested. 2021-07-21 11:49:29 +01:00			`>> - [x] Game Management Commands`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Started writing /commands. Completed channel group of config subcommands Fixed bugs in config initialisation function 2021-07-17 13:56:04 +01:00			`> - [x] Native Bot Commands`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Finished writing Pitch command. Needs further testing. Prepare to write member verification and event listeners next. 2021-07-23 00:44:21 +01:00			`- [x] Migrate existing bot commands`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Wrote Create and Delete Game commands Untested. 2021-07-19 02:26:35 +01:00			`> - [x] setupgame`
Started writing /commands. Completed channel group of config subcommands Fixed bugs in config initialisation function 2021-07-17 13:56:04 +01:00			`> - [x] ~~definebotrole~~ config`
Wrote Create and Delete Game commands Untested. 2021-07-19 02:26:35 +01:00			`> - [x] deletegame`
Wrote player commands, still not tested. 2021-07-21 11:49:29 +01:00			`> - [x] ~~reset~~ purge`
Finished writing Pitch command. Needs further testing. Prepare to write member verification and event listeners next. 2021-07-23 00:44:21 +01:00			> - [ ] ~~migrate~~ `See above`
Wrote player commands, still not tested. 2021-07-21 11:49:29 +01:00			> - [x] ~~kickplayer~~ `/player remove`
			> - [x] ~~addplayer~~ `/player add`
			> - [x] ~~leavegame~~ `/player leave`
Finished writing Pitch command. Needs further testing. Prepare to write member verification and event listeners next. 2021-07-23 00:44:21 +01:00			`> - [x] Pitch command and sub-commands`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Finished writing Pitch command. Needs further testing. Prepare to write member verification and event listeners next. 2021-07-23 00:44:21 +01:00			> > - [ ] ~~run~~ `Combined both sub-commands into single command and prompt response.`
			`> > - [ ] ~~clear~~`
15 July Build Implemented YAML Implemented basic client introspection for guild metadata Added todo tracker 2021-07-15 09:03:44 +01:00
			`## Misc`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Updated documentation. Changed virtual environment settings. Beginning change to data structure. 2021-07-16 08:37:06 +01:00			`- [ ] Review documentation`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Updated documentation. Changed virtual environment settings. Beginning change to data structure. 2021-07-16 08:37:06 +01:00			`> - [ ] Finalise README.md`
			`> - [ ] CHANGELOG.md`
			`> - [ ] COMMANDS.md`
Changed how delete time slot functions 2021-07-20 21:43:22 +01:00			`> - [ ] resources.md`
Issue present with Purge command 2021-07-21 23:05:13 +01:00
Finished writing Pitch command. Needs further testing. Prepare to write member verification and event listeners next. 2021-07-23 00:44:21 +01:00			- [ ] Make sure to document `not using discord_components and staying with discord-py-slash-commands library alone`.