diff --git a/README.md b/README.md index 597b39b447..37af891ee4 100644 --- a/README.md +++ b/README.md @@ -1,102 +1,152 @@ +@@ -0,0 +1,161 @@ frame (3) -# [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 + ### 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] + +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. -![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) - -