Skip to content

keeneye7/deep-breath

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

20 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

# Audio Visualizer with Three.js

This project is an audio visualizer that uses Three.js to create a dynamic Milky Way animation and a volume-based visualizer that responds to audio input. The visualizer is controlled through a simple web interface.

## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [File Structure](#file-structure)
- [Customization](#customization)
- [Contributing](#contributing)
- [License](#license)

## Installation

### Prerequisites
- Node.js and npm (if you need to manage dependencies and build tools)
- A modern web browser with WebGL support

### Steps
1. Clone the repository:
   ```bash
   git clone https://github.com/your-username/audio-visualizer.git
   cd audio-visualizer
  1. (Optional) If you're using npm to manage dependencies and build tools, install the necessary packages:
    npm install

Usage

  1. Open the index.html file in your web browser:

    open index.html
  2. Use the provided controls to play, pause, and adjust the volume of the background music.

  3. Click anywhere on the page to start the background music and the visualizer.

File Structure

audio-visualizer/
│
├── index.html
├── main.js
├── threejs-setup.js
├── styles.css
├── assets/
│   └── background-music.mp3
└── README.md
  • index.html: The main HTML file containing the structure of the web page.
  • main.js: Handles the DOMContentLoaded event, user interactions, volume control, and audio visualization setup.
  • threejs-setup.js: Contains the Three.js setup and animation logic.
  • styles.css: Contains the styles for the web page.
  • assets/: Directory for audio files and other assets.
  • README.md: This README file.

Customization

Changing the Background Music

Replace the background-music.mp3 file in the assets directory with your own audio file. Update the src attribute of the audio element in index.html if the file name or path changes.

Modifying Visualizer Settings

  • Adjust the number of stars in the Milky Way or the speed of animation in threejs-setup.js.
  • Change the appearance of the visualizer bars in the styles.css file.

Contributing

Contributions are welcome! If you have any ideas for improvements or find bugs, please open an issue or submit a pull request.

Steps to Contribute

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes and commit them (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature-branch).
  5. Open a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Live Demo

Check out the live demo of the project at deepbreath.us.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published