Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
154 changes: 102 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,102 +1,152 @@
@@ -0,0 +1,161 @@
<img width="3188" height="1202" alt="frame (3)" src="https://github.com/user-attachments/assets/517ad8e9-ad22-457d-9538-a9e62d137cd7" />


# [Project Name] 🎯
# GRUMBLE BOT 🎯


## Basic Details
### Team Name: [Name]
### Team Name: WIERDO


### Team Members
- Team Lead: [Name] - [College]
- Member 2: [Name] - [College]
- Member 3: [Name] - [College]
- Team Lead: AMAR ASHIQUE - ICET MUVATTUPUZHA

### Project Description
[2-3 lines about what your project does]
GrumbleBot is an entertaining, sarcastic smart speaker that responds to voice and text commands with witty, unhelpful phrases. It features a dynamic mood system, a unique voice visualizer, and a responsive interface that changes color and animation based on the bot's grumpy personality. It's a fun parody of conventional AI assistants like Alexa or Siri.

### The Problem (that doesn't exist)
[What ridiculous problem are you solving?]
The project addresses the utterly ridiculous and non-existent problem of overly cheerful and helpful smart speakers. GrumbleBot solves the dire need for a digital assistant that embraces pessimism, apathy, and sass. It provides a much-needed, grumpy alternative to the relentlessly positive bots of today, giving users a truly miserable and entertaining experience.

### The Solution (that nobody asked for)
[How are you solving it? Keep it fun!]
After months of meticulous, pointless effort, we have successfully created a bot that is not helpful. How did we achieve this monument to apathy? We didn't waste a single moment on useful technology.

The Sassy-Tentacle Detection System™ 🐙
Instead of using complex, modern advancements to understand your questions, we built a highly advanced system that simply looks for keywords. Ask about the weather, and it instantly sniffs out that word to deliver a grumpy pre-written response. It's like having a grumpy parrot that knows a few phrases, but with less feathers and more existential dread.

The Mood-A-Meter (patent pending) 😠
We've meticulously coded a digital personality that gets angrier the more you use it. Every time you try to get a helpful response, its "Mood-A-Meter" fills up. At a certain point, it snaps and delivers an even more irritable response. It’s an interactive journey into frustration, and you are the star!

The I'd-Rather-Not Visualizer 🎨
And finally, the visualizer! Why display something useful like a waveform? Our visualizer does what it does best: it exists. It pulses with a colorful, pointless aura of sadness and passive-aggression, perfectly reflecting the internal state of our heroic bot. We've managed to turn a simple sound wave into a visual representation of pure "ugh." A triumph for art, a failure for everything else!

## Technical Details
### Technologies/Components Used
For Software:
- [Languages used]
- [Frameworks used]
- [Libraries used]
- [Tools used]
- JAVASCRIPT
HTML
CSS

- VS CODE

For Hardware:
- [List main components]
- [List specifications]
- [List tools required]
- CHROME BROWSER
- VSCODDE

Comment on lines +43 to +45
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Incorrect items under “For Hardware” + typo

“CHROME BROWSER” and “VSCODDE” are software; also “VSCODDE” is misspelled. Either move them to software or replace this with actual hardware. Example fix:

- - CHROME BROWSER
- - VSCODDE
+ - Microphone
+ - Speakers or headphones
+ - Display (monitor or device screen)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- CHROME BROWSER
- VSCODDE
- Microphone
- Speakers or headphones
- Display (monitor or device screen)
🧰 Tools
🪛 LanguageTool

[grammar] ~44-~44: Ensure spelling is correct
Context: ... CODE For Hardware: - CHROME BROWSER - VSCODDE ### Implementation For Software: # In...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
In README.md around lines 43 to 45, the items listed under "For Hardware"
include "CHROME BROWSER" and "VSCODDE," which are software, and "VSCODDE" is
misspelled. Correct this by either moving these items to the software section or
replacing them with actual hardware items. Also, fix the typo by changing
"VSCODDE" to "VSCode."


### Implementation
For Software:
# Installation
[commands]
No installation is required. The project is a single HTML file and runs directly in any modern web browser that supports the Web Speech API and Web Audio API (such as Chrome, Firefox, or Edge).

# Run
[commands]

Comment on lines 49 to +53
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Fix heading level jumps (MD001)

Headings should increment by one level. Change “# Installation” and “# Run” to sub-headings under “Implementation”.

-# Installation
+#### Installation
@@
-# Run
+#### Run
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
# Installation
[commands]
No installation is required. The project is a single HTML file and runs directly in any modern web browser that supports the Web Speech API and Web Audio API (such as Chrome, Firefox, or Edge).
# Run
[commands]
#### Installation
No installation is required. The project is a single HTML file and runs directly in any modern web browser that supports the Web Speech API and Web Audio API (such as Chrome, Firefox, or Edge).
#### Run
🧰 Tools
🪛 LanguageTool

[style] ~50-~50: Consider replacing this word to strengthen your wording.
Context: ...ired. The project is a single HTML file and runs directly in any modern web browser...

(AND_THAT)

🤖 Prompt for AI Agents
In README.md around lines 49 to 53, the headings "Installation" and "Run" are at
the top level (#) causing heading level jumps. Change these headings to one
level deeper (e.g., ## or ###) so they become sub-headings under the existing
"Implementation" heading, ensuring proper heading hierarchy and compliance with
MD001.

Save the entire code into a file named grumblebot.html.

Open the file directly in your web browser.

### Project Documentation
For Software: Project Description
GrumbleBot is an entertaining, sarcastic smart speaker that responds to voice and text commands with witty, unhelpful phrases. It features a dynamic mood system, a unique voice visualizer, and a responsive interface that changes color and animation based on the bot's grumpy personality. It's a fun parody of conventional AI assistants like Alexa or Siri.

The Problem (that doesn't exist)
The project addresses the utterly ridiculous and non-existent problem of overly cheerful and helpful smart speakers. GrumbleBot solves the dire need for a digital assistant that embraces pessimism, apathy, and sass. It provides a much-needed, grumpy alternative to the relentlessly positive bots of today, giving users a truly miserable and entertaining experience.

The Solution (that nobody asked for)
Behold! The genius, heroic solution to a problem that never existed!

After months of meticulous, pointless effort, we have successfully created a bot that is not helpful. How did we achieve this monument to apathy? We didn't waste a single moment on useful technology.

The "Sassy-Tentacle" Detection System™ 🐙
Instead of using complex, modern advancements to understand your questions, we built a highly advanced system that simply looks for keywords. Ask about the "weather," and it instantly sniffs out that word to deliver a grumpy pre-written response. It's like having a grumpy parrot that knows a few phrases, but with less feathers and more existential dread.

The "Mood-A-Meter" (patent pending) 😠
We've meticulously coded a digital personality that gets angrier the more you use it. Every time you try to get a helpful response, its "Mood-A-Meter" fills up. At a certain point, it snaps and delivers an even more irritable response. It’s an interactive journey into frustration, and you are the star!

The "I'd-Rather-Not" Visualizer 🎨
And finally, the visualizer! Why display something useful like a waveform? Our visualizer does what it does best: it exists. It pulses with a colorful, pointless aura of sadness and passive-aggression, perfectly reflecting the internal state of our heroic bot. We've managed to turn a simple sound wave into a visual representation of pure "ugh." A triumph for art, a failure for everything else!

Technical Details
For Software:

# Screenshots (Add at least 3)
![Screenshot1](Add screenshot 1 here with proper name)
*Add caption explaining what this shows*
Languages Used:

![Screenshot2](Add screenshot 2 here with proper name)
*Add caption explaining what this shows*
HTML5 for structuring the page content.

![Screenshot3](Add screenshot 3 here with proper name)
*Add caption explaining what this shows*
CSS3 for styling, animations, and responsive design.

# Diagrams
![Workflow](Add your workflow/architecture diagram here)
*Add caption explaining your workflow*
JavaScript (ES6+) for all dynamic functionality.

For Hardware:
Frameworks Used:

No external frameworks were used; the project is built with vanilla JavaScript, HTML, and CSS.

Libraries Used:

No external libraries were used. The project relies on the Web Speech API for speech recognition and synthesis, and the Web Audio API for the dynamic visualizer.

Tools Used:

# Schematic & Circuit
![Circuit](Add your circuit diagram here)
*Add caption explaining connections*
Browser Developer Tools for debugging and testing.

![Schematic](Add your schematic diagram here)
*Add caption explaining the schematic*
A code editor like Visual Studio Code.

# Build Photos
![Components](Add photo of your components here)
*List out all components shown*
For Hardware
List main components:

![Build](Add photos of build process here)
*Explain the build steps*
A computer (desktop, laptop, or single-board computer like a Raspberry Pi).

An integrated or external microphone for speech input.

Speakers or headphones for speech output.

A display screen (monitor, laptop screen, or phone screen).

List specifications:

The project is not hardware-intensive. Any modern computer or mobile device with a working microphone and speakers is sufficient.

A reliable internet connection is needed for loading some of the assets (like the sound effect) and for the Web Speech API to function correctly in some browsers.

List tools required:

A modern web browser (Google Chrome, Mozilla Firefox, Microsoft Edge) that supports the Web Speech and Web Audio APIs.

A text editor (e.g., VS Code, Sublime Text, Notepad++) to write and edit the code.



# Screenshots (Add at least 3)
https://github.com/amarashique726-bit/grumblebot/blob/main/S1%20LOW.jpg - LOW WHINE MODE
This screenshot shows GrumbleBot in its "Low Whine" mood. The overall theme is a calm, slightly despondent blue and green. The bot's emoji face has a neutral, almost bored expression. The chat history shows the bot responding to a user's question, "WHAT IS THE TIME NOW," with a non-committal and unhelpful answer, "It's late. Or early. Take your pick." The interface is muted and lacks high-energy animations, reflecting the bot's low-key, whining personality.



https://github.com/amarashique726-bit/grumblebot/blob/main/S2%20MID.jpg - MEDIUM WHINE
In this screenshot, GrumbleBot is in its "Medium Whine" mood. The background shifts to a warmer, more agitated orange and yellow gradient. The bot's emoji face shows a more pronounced look of annoyance and irritation. The chat shows two user questions and a sarcastic bot response: "WHAT IS THE TIME NOW" gets "It's late. Or early. Take your pick," and "CAN YOU PLAY A SONG FOR ME" receives a grumpy "I don't play music, I play the sad trombone." This mood is characterized by more visible frustration and a slightly more colorful interface.


https://github.com/amarashique726-bit/grumblebot/blob/main/S3%20HIGH.jpg - EXTREME DIVA
This screenshot captures GrumbleBot in its most irritable state, the "Extreme Diva" mood. The background has intensified to a bright, angry red and yellow. The emoji face is now visibly furious, with furrowed brows and a scowling expression. The chat history shows the bot's mood degrading to "high whine" and it replies to "WHAT IS THE WEATHER NOW" with an overtly hostile and sarcastic comment: "Do I look like a weatherman? I'm a grumbleman." This state is defined by a chaotic, high-energy visual theme and the most aggressive, dismissive responses.
Comment on lines +130 to +140
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Avoid bare URLs (MD034) and add alt text/captions for accessibility

Embed screenshots with Markdown image syntax and captions.

-https://github.com/amarashique726-bit/grumblebot/blob/main/S1%20LOW.jpg - LOW WHINE MODE
-This screenshot shows GrumbleBot in its "Low Whine" mood. The overall theme is a calm, slightly despondent blue and green. The bot's emoji face has a neutral, almost bored expression. The chat history shows the bot responding to a user's question, "WHAT IS THE TIME NOW," with a non-committal and unhelpful answer, "It's late. Or early. Take your pick." The interface is muted and lacks high-energy animations, reflecting the bot's low-key, whining personality.
+![Screenshot: Low Whine Mode](https://github.com/amarashique726-bit/grumblebot/blob/main/S1%20LOW.jpg)
+_Low Whine Mode_: Calm blue/green theme, neutral emoji, non-committal response.

@@
-https://github.com/amarashique726-bit/grumblebot/blob/main/S2%20MID.jpg - MEDIUM WHINE
+![Screenshot: Medium Whine Mode](https://github.com/amarashique726-bit/grumblebot/blob/main/S2%20MID.jpg)
+_Medium Whine Mode_: Warmer orange/yellow, more visible frustration.

@@
-https://github.com/amarashique726-bit/grumblebot/blob/main/S3%20HIGH.jpg - EXTREME DIVA
+![Screenshot: Extreme Diva Mode](https://github.com/amarashique726-bit/grumblebot/blob/main/S3%20HIGH.jpg)
+_Extreme Diva Mode_: Intense red/yellow theme, most aggressive responses.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
https://github.com/amarashique726-bit/grumblebot/blob/main/S1%20LOW.jpg - LOW WHINE MODE
This screenshot shows GrumbleBot in its "Low Whine" mood. The overall theme is a calm, slightly despondent blue and green. The bot's emoji face has a neutral, almost bored expression. The chat history shows the bot responding to a user's question, "WHAT IS THE TIME NOW," with a non-committal and unhelpful answer, "It's late. Or early. Take your pick." The interface is muted and lacks high-energy animations, reflecting the bot's low-key, whining personality.
https://github.com/amarashique726-bit/grumblebot/blob/main/S2%20MID.jpg - MEDIUM WHINE
In this screenshot, GrumbleBot is in its "Medium Whine" mood. The background shifts to a warmer, more agitated orange and yellow gradient. The bot's emoji face shows a more pronounced look of annoyance and irritation. The chat shows two user questions and a sarcastic bot response: "WHAT IS THE TIME NOW" gets "It's late. Or early. Take your pick," and "CAN YOU PLAY A SONG FOR ME" receives a grumpy "I don't play music, I play the sad trombone." This mood is characterized by more visible frustration and a slightly more colorful interface.
https://github.com/amarashique726-bit/grumblebot/blob/main/S3%20HIGH.jpg - EXTREME DIVA
This screenshot captures GrumbleBot in its most irritable state, the "Extreme Diva" mood. The background has intensified to a bright, angry red and yellow. The emoji face is now visibly furious, with furrowed brows and a scowling expression. The chat history shows the bot's mood degrading to "high whine" and it replies to "WHAT IS THE WEATHER NOW" with an overtly hostile and sarcastic comment: "Do I look like a weatherman? I'm a grumbleman." This state is defined by a chaotic, high-energy visual theme and the most aggressive, dismissive responses.
![Screenshot: Low Whine Mode](https://github.com/amarashique726-bit/grumblebot/blob/main/S1%20LOW.jpg)
_Low Whine Mode_: Calm blue/green theme, neutral emoji, non-committal response.
![Screenshot: Medium Whine Mode](https://github.com/amarashique726-bit/grumblebot/blob/main/S2%20MID.jpg)
_Medium Whine Mode_: Warmer orange/yellow, more visible frustration.
In this screenshot, GrumbleBot is in its "Medium Whine" mood. The background shifts to a warmer, more agitated orange and yellow gradient. The bot's emoji face shows a more pronounced look of annoyance and irritation. The chat shows two user questions and a sarcastic bot response: "WHAT IS THE TIME NOW" gets "It's late. Or early. Take your pick," and "CAN YOU PLAY A SONG FOR ME" receives a grumpy "I don't play music, I play the sad trombone." This mood is characterized by more visible frustration and a slightly more colorful interface.
![Screenshot: Extreme Diva Mode](https://github.com/amarashique726-bit/grumblebot/blob/main/S3%20HIGH.jpg)
_Extreme Diva Mode_: Intense red/yellow theme, most aggressive responses.
This screenshot captures GrumbleBot in its most irritable state, the "Extreme Diva" mood. The background has intensified to a bright, angry red and yellow. The emoji face is now visibly furious, with furrowed brows and a scowling expression. The chat history shows the bot's mood degrading to "high whine" and it replies to "WHAT IS THE WEATHER NOW" with an overtly hostile and sarcastic comment: "Do I look like a weatherman? I'm a grumbleman." This state is defined by a chaotic, high-energy visual theme and the most aggressive, dismissive responses.
🧰 Tools
🪛 LanguageTool

[style] ~140-~140: Try using a synonym here to strengthen your wording.
Context: ..." with an overtly hostile and sarcastic comment: "Do I look like a weatherman? I'm a gr...

(COMMENT_REMARK)

🪛 markdownlint-cli2 (0.17.2)

130-130: Bare URL used

(MD034, no-bare-urls)


135-135: Bare URL used

(MD034, no-bare-urls)


139-139: Bare URL used

(MD034, no-bare-urls)

🤖 Prompt for AI Agents
In README.md around lines 130 to 140, the screenshots are referenced using bare
URLs without Markdown image syntax or alt text, which reduces accessibility and
clarity. Replace the bare URLs with proper Markdown image embedding syntax
including descriptive alt text for each image. Add captions below each image to
describe the mood and context, improving both accessibility and readability.


![Final](Add photo of final product here)
*Explain the final build*

### Project Demo
# Video
[Add your demo video link here]
*Explain what the video demonstrates*

# Additional Demos
[Add any extra demo materials/links]

## Team Contributions
- [Name 1]: [Specific contributions]
- [Name 2]: [Specific contributions]
- [Name 3]: [Specific contributions]
- AMAR ASHIQUE : DEVELOPER

---
Made with ❤️ at TinkerHub Useless Projects

![Static Badge](https://img.shields.io/badge/TinkerHub-24?color=%23000000&link=https%3A%2F%2Fwww.tinkerhub.org%2F)
![Static Badge](https://img.shields.io/badge/UselessProjects--25-25?link=https%3A%2F%2Fwww.tinkerhub.org%2Fevents%2FQ2Q1TQKX6Q%2FUseless%2520Projects)