An open API service indexing awesome lists of open source software.

https://github.com/marcus-universe/soundninja

πŸ”ŠSound Ninja is an Open Source Soundboard App with modern design and maximal customizability. πŸ”Š
https://github.com/marcus-universe/soundninja

audio audio-player howler howlerjs memes ninja sound sound-effects soundboard soundpad tauri tauri-app vue vue3

Last synced: 30 days ago
JSON representation

πŸ”ŠSound Ninja is an Open Source Soundboard App with modern design and maximal customizability. πŸ”Š

Awesome Lists containing this project

README

        

# Sound Ninja

![Sound Ninja Logo Animated](./designs/Logo_Animated.gif)

![License](https://img.shields.io/github/license/marcus-universe/SoundNinja?style=for-the-badge.svg)
![Code Size](https://img.shields.io/github/languages/code-size/marcus-universe/SoundNinja?style=for-the-badge.svg)
![Version](https://img.shields.io/github/package-json/v/marcus-universe/SoundNinja?style=for-the-badge.svg)
![Stars](https://img.shields.io/github/stars/marcus-universe/SoundNinja?style=for-the-badge.svg)
![Forks](https://img.shields.io/github/forks/marcus-universe/SoundNinja.svg)


**Sound Ninja** is an **Open Source Soundboard App** with maximal customizability option to create your best Soundboard. Perfect for **live streaming, chatting with friends or podcast recording**. πŸ˜‰πŸ‘

## How is the progress going?

```diff
- Sound Ninja is still in development and is not ready for use!
```

The progress can be tracked on the [GitHub Project Board](https://github.com/users/marcus-universe/projects/1/views/1).

## Why Sound Ninja?

Sound Ninja is a **Open Source Soundboard App** with the goal to provide the maximal customizability options and a modern UI. Its build with **Tauri.js and Vue.js** and doesn't take much space on your pc and ram not like other soundboard apps. The main reason was to create a Soundboard-App that lets you organize really efficiently your sounds to find them really fast and easy in the moment you need them. On top, it gives everyone the option to share there soundboards with others to become together the biggest Meme-Loards of our time. 😎

## Features (+upcoming)

| Feature | Description | Status |
| ---------------------------- | --------------------------------------------------------- | ------ |
| **Soundboard** | Create your own Soundboard with your favorite sounds | βœ… |
| **Tab System** | Organize your sounds in Tabs | β›” |
| **Tag System** | Tag your favorite sounds in to cathegories | β›” |
| **Searchbar** | Find your sounds quick and easy | β›” |
| **Midi Support** | Control your Soundboard via Midi | β›” |
| **Themes** | Design your Soundboard how you like it | β›” |
| **Customizable Hotkeys** | Customize the Hotkeys to your needs | β›” |
| **Soundboard Sharing** | Share your Soundboard with your friends | β›” |
| **Soundboard Import/Export** | Import and Export your Soundboard | β›” |
| **Custom Profiles** | Create multiple Soundboards with different settings | β›” |
| **Websocket** | Control your Soundboard with your Smartphone | β›” |
| **Recorder** | Record your PC-Audio directly in Sound Ninja | β›” |
| **Speech Search** | Find sounds with the power of your voice | β›” |
| **Giphy** | Give your Sounds an Image/Gif | β›” |
| **Twitch Chat Control** | Let your community decide what to play | β›” |
| **AI Assistant** | Recommends you sounds that works in the current situation | β›” |

## Platforms

Sound Ninja currently supports theoretically the following platforms:

| Platform | Versions |
| :------- | :-------------- |
| Windows | 8 and above |
| macOS | 10.15 and above |
| Linux | See below |

**Linux Support**

- Debian (Ubuntu 18.04 and above or equivalent) with the following packages installed:
- `libwebkit2gtk-4.0-37`, `libgtk-3-0`, `libayatana-appindicator3-1`1
- Arch with the following packages installed:
- `webkit2gtk`, `gtk3`, `libayatana-appindicator`1
- Fedora (latest 2 versions) with the following packages installed:
- `webkit2gtk3`, `gtk3`, `libappindicator-gtk3`1

```diff
- Be aware that Sound Ninja is in a early development stage and so its not tested on all platforms yet.
```

## Project setup

```
npm install
```

### Available dependencies

- [Vue.js (Vue3 CLI)](https://vuejs.org/)
- [Tauri.js](https://tauri.studio/)
- [SASS](https://sass-lang.com/)
- [Vue Router](https://router.vuejs.org/)
- [Vuex](https://vuex.vuejs.org/)
- [Vue Use](https://vueuse.org/)
- [Howler.js](https://howlerjs.com/)

#### Available dependencies in future

- [Socket.io](https://socket.io/)

### Compiles and hot-reloads for development

```
npm run tauri:serve
```

### Compiles and minifies for production

```
npm run tauri:build
```

### Vue Devtools

[How to install Vue Devtools Standalone](https://devtools.vuejs.org/guide/installation.html#standalone)

```
npm run vue-devtools
```

### Lints and fixes files

```
npm run lint
```

### Customize configuration

See [Configuration Reference](https://cli.vuejs.org/config/).