WaveSabre/README.md

![WaveSabre](Media/logo-black.png)

[![build status](https://ci.appveyor.com/api/projects/status/4su4q028eywtr5gl?svg=true)](https://ci.appveyor.com/project/yupferris/wavesabre) [![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/logicomacorp/WaveSabre#license) [![Slack](https://img.shields.io/badge/chat-Slack-orange.svg)](https://join.slack.com/t/wavesabre/shared_invite/enQtNTYwNDA2MTgwODM5LWI0OGNjNWY5Njc1ZTA5MzQ0NjZiN2M3NzNhOWFiZjNiMmEwM2EzZWFjNzAzZWQzZWNkOWJiOGExMWY3ZGJmNTI)

## Description

WaveSabre is a software synthesizer and toolchain for music for [64K intros](https://en.wikipedia.org/wiki/64K_intro).

See [our docs](https://github.com/logicomacorp/WaveSabre/tree/master/Docs) for more info.

## Getting started

Please see [our docs](https://github.com/logicomacorp/WaveSabre/blob/master/Docs/Home.md#building) for prerequisites, building, etc (and let us know what we're missing!).

## Status/contributing

As WaveSabre is hot and fresh right out of the oven, we've got some kinks to work out; particularly with documentation, support for more Visual Studio versions, and supporting various VST SDK versions. We'd appreciate any help we can get on any of these fronts, so please talk to us on Slack so we can guide you in the right direction and help you help us!

Contributions are very welcome, however as the public release is still in its infancy, we'd greatly appreciate it if we could discuss contributions on [Slack](https://join.slack.com/t/wavesabre/shared_invite/enQtNTYwNDA2MTgwODM5LWI0OGNjNWY5Njc1ZTA5MzQ0NjZiN2M3NzNhOWFiZjNiMmEwM2EzZWFjNzAzZWQzZWNkOWJiOGExMWY3ZGJmNTI), rather than just opening up for pull requests for the time being, in order to avoid duplicate work. This will change in the future when things mature/settle down a bit. :)

## Productions

WaveSabre has been used in several intros, demos, and executable entries, including (but not limited to):

- [dope on wax](http://www.pouet.net/prod.php?which=81015) by [logicoma](http://www.pouet.net/groups.php?which=12638), 2019
- [trashpanda](http://www.pouet.net/prod.php?which=78634) by [logicoma](http://www.pouet.net/groups.php?which=12638), 2018
- [bros before foes](http://www.pouet.net/prod.php?which=77682) by [logicoma](http://www.pouet.net/groups.php?which=12638) and [poo-brain](http://www.pouet.net/groups.php?which=12000), 2018
- [iota](http://www.pouet.net/prod.php?which=75718) by [logicoma](http://www.pouet.net/groups.php?which=12638), 2018
- [soundproof motion](http://www.pouet.net/prod.php?which=70460) by [logicoma](http://www.pouet.net/groups.php?which=12638) and [fairlight](http://www.pouet.net/groups.php?which=44), 2017
- [engage](http://www.pouet.net/prod.php?which=69658) by [logicoma](http://www.pouet.net/groups.php?which=12638), 2017
- [elysian](http://www.pouet.net/prod.php?which=68375) by [logicoma](http://www.pouet.net/groups.php?which=12638), 2016
- [backscatter](http://www.pouet.net/prod.php?which=65966) by [logicoma](http://www.pouet.net/groups.php?which=12638), 2015

If you've used WaveSabre in a production and would like it included in this list, feel free to submit a pull request!

## Team

WaveSabre is made by [ferris](https://github.com/yupferris) and [h0ffman](https://github.com/djh0ffman) of [logicoma](https://github.com/logicomacorp), with additional contributions by:

- [revival](https://github.com/revivalizer) (knob graphics, premake integration, helping with open-source prep, ...)
- [kusma](https://www.kusma.xyz/) (sin/cos optimization, cmake integration, appveyor config, ...)
- [cptd](https://github.com/cpdt) ([FL Studio project parser](https://github.com/logicomacorp/WaveSabre/tree/master/WaveSabreConvert/FLParser))
- [Wertstahl](http://wertstahl.de) (logo)

And several others! _(Please let us know if we forgot someone!)_

## Talks/seminars

- [Massive Sound, Tiny Data - WaveSabre 64k Synth](https://youtu.be/JjFyHI1b_Tw?t=7246) by ferris/h0ffman, [demobit](https://www.demobit.party/) 2019
- [Ferris Makes Demos Ep.001 - WaveSabre](https://www.youtube.com/watch?v=V8JXraZPkh8) by ferris, 2017 stream
- [WaveSabre - A Case Study in 64k Synthesis](https://www.youtube.com/watch?v=wLX156OVFTA) by ferris, [the gathering 2013](https://archive.gathering.org/tg13)

## License

WaveSabre is licensed under the MIT license (see [LICENSE](LICENSE) or http://opensource.org/licenses/MIT).