Skip to content

Commit

Permalink
docs: README
Browse files Browse the repository at this point in the history
  • Loading branch information
deermichel committed Jun 15, 2023
1 parent ea8d702 commit b4e11e3
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,41 @@
# waveterrain

![screenshot](img/screenshot.png)
Imagine taking a 3D terrain and interpreting the height values along a path as samples of an audio signal.
That's the concept behind wave terrain synthesis.

Inspired by [this](https://mu.krj.st/assignments/osc_s.html) article, I created an interactive demo that allows you to explore wave terrain synthesis directly in your browser.
It is at the same time my playground for cutting edge web stuff.

This project is explicitly open for contributions, and if you need inspiration, just pick one of the items from the [roadmap](#roadmap).
If you have any further questions or want to discuss an idea, feel free to reach out to me.

Should this project become mature enough, I consider packaging it as a VST/AU plugin so that it can be used in other audio software.

## Roadmap
TODO

## Tech Stack
- [three.js](https://threejs.org/) - for the gorgeous 3D visualization
- [Web Audio API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Audio_API) - specifically the `AudioWorkletProcessor` for sound synthesis
- [emscripten](https://emscripten.org/) - moving the audio processing code to WebAssembly is still a TODO
- [svelte](https://svelte.dev/) - people said it's the new React, okay
- [tailwind.css](https://tailwindcss.com/) - maybe i'm doing it wrong, but i'd have preferred plain css
- [TypeScript](https://www.typescriptlang.org/) - always a good idea
- [vite](https://vitejs.dev/) - who likes webpack anyway

## Build Instructions
```sh
# clone repo
git clone https://github.com/deermichel/waveterrain.git

# install dependencies
cd waveterrain
npm install

# build and start dev server
npm run dev
```

## License
This project is released under the [MIT License](LICENSE).
Binary file added img/screenshot.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b4e11e3

Please sign in to comment.