Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 1.91 KB

plan.md

File metadata and controls

71 lines (49 loc) · 1.91 KB
Raw

Dr. Jams Discord Bot Plan

Author: Adrian Tarantino

Created: August 30, 2022 Last Updated: August 30, 2022

Credits to https://www.educative.io/blog/how-to-plan-a-coding-project for giving me an outline of what content is needed inside a plan.

Intentions behind the project

  • Mainly a joke for me and my friends discord server
  • Practice / Learn the rust programming language

Core functionality

  • Read TTS (Text-to-Speech) messages and repeat them inside of discord VC
  • Play songs / sound effects inside of a discord VC [Extra Feature]

Similar Projects

https://github.com/kangalioo/rustbot

Tools

Language(s)
  1. Rust - I'm using this language cause I like it a lot
External Crates
  1. Serenity - Serenity is a Rust library for the Discord API
  1. tts_rust - A rust library designed for TTS
Code Editor
  1. VS Code - IDK, I've used this editor for a while and I'm used to it now
Version Control
  1. Git and Github - What else is there to use?

Features

Beta Features (Version 0.1 - 0.9)
  1. Read messages sent in discord server
  2. Say messages as TTS
Essential Features (Version 1.0 - 1.9)
  1. All Beta Features
  2. Say messages inside of discord VC
Non-Essential Features (Version 2.0 +)
  1. All Essential Features
  2. Play songs / sound effects inside of a discord VC

Process (Essential Features)

https://docs.google.com/drawings/d/1wM-xPwBPAx8rCD1nEWO2zp_4LSCm72IQqwY-qnYvYHE/edit?usp=sharing

Entities Setup

  1. Discord bot on https://www.google.com/url?sa=t&rct=j&q=&esrc=s&source=web&cd=&cad=rja&uact=8&ved=2ahUKEwig69Oy6O_5AhWSjYkEHWxkAbEQFnoECAoQAQ&url=https%3A%2F%2Fdiscord.com%2Fdevelopers%2Fdocs&usg=AOvVaw03p7P12f_5No1XoZMli0fv

Schedule

Version 0.1 [September 1]
  1. All of the Beta Features
Version 1.0 [September 3]
  1. All of the Essential Features
Version 1.1 [September 5]
  1. All of the Non-Essential Features