Skip to content

synapseq-foundation/synapseq

SynapSeq

Release License Commit Activity

Text-Driven Audio Sequencer for Brainwave Entrainment

SynapSeq is a text-driven audio sequencer for building clear, repeatable brainwave and ambient sessions using a simple domain-specific language, written as SynapSeq sequences (.spsq).

Visit synapseq.org for more information.

Quick Start

The recommended way to install SynapSeq is through the platform package manager.

Homebrew (macOS & Linux)

Install with Homebrew:

brew tap synapseq-foundation/synapseq
brew install synapseq

Winget (Windows)

Install with Winget:

winget update
winget install synapseq

After installation, you can run synapseq -install-file-association to associate .spsq files with SynapSeq and enable additional Explorer context menu actions.

Manual Downloads

If you prefer to install manually, download the appropriate archive from the latest GitHub release: v4.0.2.

If you want to build SynapSeq from source, see the Compilation Guide.

Usage

After installation on any platform, run synapseq -manual to open the built-in manual, or read USAGE in this repository.

Go API

If you want to integrate SynapSeq into a Go project, use the Go module API.

WASM API

If you want to integrate SynapSeq into a browser-based application, see the WASM JavaScript API Reference.

Contributing

We welcome contributions!

Please read the CONTRIBUTING file for guidelines on how to contribute code, bug fixes, and documentation to the project.

License

SynapSeq is distributed under the GPL v2 license. See the COPYING file for details.

Third-Party Licenses

All original code in SynapSeq is licensed under the GNU GPL v2, but the following components are included and redistributed under their respective terms:

  • fatih/color
    License: MIT
    Used for colorized terminal output.

  • beep
    License: MIT
    Used for audio encoding/decoding.

  • golang.org/x/sys
    License: BSD 3-Clause
    Used for platform-specific system integration.

  • go-colorable
    License: MIT
    Used indirectly for cross-platform ANSI color support.

  • go-isatty
    License: MIT
    Used indirectly for terminal capability detection.

  • pkg/errors
    License: BSD 2-Clause
    Used indirectly for error wrapping and stack trace utilities.

All third-party copyright notices and licenses are preserved in this repository in compliance with their original terms.

Contact

We'd love to hear from you! Here's how to get in touch:

Issues (Bug Reports & Feature Requests)

Use GitHub Issues for:

  • Bug reports and technical problems
  • Feature requests and enhancement suggestions
  • Documentation improvements

Discussions (Questions & Community)

Use GitHub Discussions for:

  • General questions and support (e.g., "How do I use @extends?")
  • Help with your sequences (e.g., "My sequence isn't working, can you help?")
  • Sharing your own sequences and presets with the community
  • Discussing ideas and best practices
  • Showcasing creative use cases

Quick Guidelines

  • Found a bug? → Open an Issue
  • Want a new feature? → Open an Issue
  • Need help or have questions? → Start a Discussion
  • Want to share your sequences? → Post in Discussions
  • General feedback or ideas? → Start a Discussion

Credits

Check out the CREDITS to see a list of all contributors and special thanks!