speedmaster

9. Audio Game - Software Engineering Project

---

SpeedMaster - A quick reaction game for the Visually Impaired

SpeedMaster is a audio-based fast paced game designed to provide an engaging and accessible experience for visually impaired players. The game replaces traditional visual cues with audio feedback, allowing players to rely entirely on sound and keyboard controls.

---

Features

Core Gameplay

• Audio cues for audio gameplay.
• Keyboard controls to match notes (A, S, D, F, G) with audio cues.

Accessibility

• Audio-guided menu navigation with keyboard controls.
• colors

Sound Design

• instrument sounds for each note.

User Interface

• Fully keyboard navigable.
• Touchscreen

Deployment

• Live and accessible via web browsers.
• Deployed on Netlify for seamless access.

The game is deployed on Netlify. Visit the live version here(also mobile-friendly):
Live Game URL

---

How to Play

1. Start the Game:

   • Press Space to start a new game or T to enter the tutorial.

2. During Gameplay:

   • Listen for audio cues indicating notes (A, S, D, F, G).
   • Press the corresponding key in time with the sound.
   • Earn points based on timing accuracy and build combo streaks.

3. End of Game:

   • View your total score and high score.
   • Replay the game or return to the main menu.

---

Getting Started

Requirements

• Node.js and npm installed on your machine.
• A web browser for testing or playing the game.(Brave Browser is a little buggy)

Installation

1. Clone this repository:

   git clone https://github.com/Kakaobaum/speedmaster.git

2. Navigate to the project directory:

   cd speedmaster

3. Install dependencies:

   npm install

Running the Game Locally

1. Start the development server:

   npm run dev

2. Open your browser and navigate to the created link.

Buildung the app

npm run build

---

Project Structure

speedmaster-game
├── index.html
├── package-lock.json
├── package.json
├── postcss.config.js
├── README.md
├── src
│   ├── components
│   │   ├── GameOver.tsx
│   │   ├── MainMenu.tsx
│   │   └── Tutorial.tsx
│   ├── hooks
│   │   └── useAudio.ts
│   ├── App.tsx
│   ├── constants.ts
│   ├── index.css
│   ├── main.tsx
│   ├── types.ts
│   └── vite-env.d.ts
├── tailwind.config.js
├── tsconfig.app.json
├── tsconfig.json
├── tsconfig.node.json
├── vite.config.ts
└── .gitignore

---

Contributing

We welcome contributions! If you'd like to enhance SpeedMaster:

1. Fork the repository.
2. Create a new branch:

   git checkout -b feature-name

3. Make your changes and commit them:

   git commit -m "Add your message"

4. Push the branch:

   git push origin feature-name

5. Create a pull request.

---

Acknowledgments

• React: For the foundation of the game.
• Netlify: For providing an easy deployment platform.
• github copilot
• Dominic Dolezal: For supervising us

---