Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/negue/meme-box
Manage and trigger media in OBS as a browser source
https://github.com/negue/meme-box
hacktoberfest hacktoberfest-2022 hacktoberfest2022 obs obs-studio streamdeck-plugin twitch twitch-api
Last synced: 3 months ago
JSON representation
Manage and trigger media in OBS as a browser source
- Host: GitHub
- URL: https://github.com/negue/meme-box
- Owner: negue
- License: agpl-3.0
- Created: 2020-06-30T15:47:00.000Z (over 4 years ago)
- Default Branch: develop
- Last Pushed: 2023-11-14T17:47:43.000Z (about 1 year ago)
- Last Synced: 2024-10-16T06:12:36.841Z (3 months ago)
- Topics: hacktoberfest, hacktoberfest-2022, hacktoberfest2022, obs, obs-studio, streamdeck-plugin, twitch, twitch-api
- Language: TypeScript
- Homepage: meme-box.vercel.app
- Size: 17.2 MB
- Stars: 111
- Watchers: 4
- Forks: 16
- Open Issues: 97
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Meme-Box | [Getting Started](#getting-started) | [How to contribute](#how-to-help--contribute)
[](#contributors-)
A complete management app for [`image / audio / video / iframe / widgets`](/tutorials/type_overview.md) "media" to be used inside OBS. Or trigger other custom actions.
|**Media Setup Example + Mobile View**|**Setup a Twitch-Trigger**|
|--|--|
|||
## Installation
### Pre-built binaries
[Download latest release!](https://github.com/negue/meme-box/releases) (currently a bit ouf of date, new release soon) - [latest nightly Builds](https://github.com/negue/meme-box-nightly/releases)
### From source
If you would like to build MemeBox from source, have a look at our dedicated [BUILD.md](BUILD.md).
### From AUR
If you're an Arch Linux user, you can install directly from the [AUR](https://aur.archlinux.org), using one of the [AUR helpers](https://wiki.archlinux.org/title/AUR_helpers).
For example, with `paru`:
```sh
paru -S memebox
```
## Working Features
Show Media
Screens (in OBS)
Triggers
Images
Animations on show / hide
[Visibility][URL_ADVANCED_SETTINGS]:
- Play (on a trigger)
- Toggle (per trigger)
- Always Visible
[Custom Position per Media / Screen][URL_ADVANCED_SETTINGS]:
- Fullscreen
- Fixed (on a position)
- Centered
- Random
Misc:
- [Custom CSS per Media / Screen][URL_ADVANCED_SETTINGS]
- drag&drop for better position items
- rotate/size/warp items
[✅ `Streamdeck Plugin`][STREAMDECK_PLUGIN]
[✅ `Deckboard Plugin`](https://github.com/gigili/deckboard-memebox)
✅ Timers
✅ Mobile View
✅ Twitch Events
- Bits
- Channel Points
- Message
- Raid
- User Ban
- Subscription
- Gift Sub
Videos
Iframes
Widgets
Play Audio
Actions
[`Trigger multiple / random Media`][URL_RECIPE]
Scripts (Action)
- Trigger other Actions with custom logic/timeouts/overrides
- Trigger OBS functions
- Write to Twitch Chat
Permanent Script
- Same as Scripts just that those will run and stay active all the time.
- Used for Bots or other functionalities
- React on custom callbacks from Twitch / OBS Events
- Create your own WebSocket-Server - see [`Script-API examples`][URL_SCRIPTS]
API for Developers
- Trigger Actions with WebSockets
- Receive all Twitch Events using WebSockets `/ws/twitch_events` to use in other Apps / Overlays
- Twitch Helix REST bridge `/api/twitchData/helix/*` instead of `https://api.twitch.tv/helix/`
-----
## Getting Started
> Note: These are the current `Getting Started` / Tutorials for this branch.
>
> To see the updated `Getting Started` / Tutorials from the released version - [click here!](https://github.com/negue/meme-box/tree/release#getting-started)
[`Installation and Getting Started`](https://github.com/meme-box/memebox-101/blob/main/00/README.md)
`Advanced`:
- [`Trigger multiple / randoms`][URL_RECIPE]
- [`Screen / Media Settings`][URL_ADVANCED_SETTINGS]
- [`Scripts`][URL_SCRIPTS]
- [`Widgets`][URL_WIDGETS]
[URL_RECIPE]: tutorials/recipe.md
[URL_SCRIPTS]: tutorials/scripts.md
[URL_WIDGETS]: tutorials/widgets.md
[URL_ADVANCED_SETTINGS]: ./tutorials/screen_media_advanced_settings.md
[STREAMDECK_PLUGIN]: ./memebox-streamdeck/Release/com.memebox.memebox-streamdeck.streamDeckPlugin
___
## Roadmap
### 2023.1 (maybe 2024.1, depending how long it takes)
- Main Feature: [Refactor Trigger System / Config](https://github.com/negue/meme-box/pull/560)
- Easier way to add more types of triggers
- Also adds the command blocks per trigger (easier way to just "do" stuff)
Dependencies for that: ^
- https://github.com/negue/meme-box/pull/558 &
- a current big refactor to how the repository is working internally (NPM -> PNPM)
- these changes will be hopefully soon(TM) done/merged (Current Date of Writing this: 14th of November 2023)
- been already working on this for 3 months... yay.
### [Future Version](ROADMAP.md)
## How to help / contribute?
* Improve Docs / Translations
* Find bugs
* Suggestions to make `things` (UI, Text, Docs etc) more understandable
* Help fix bugs / improve features
* [Good First Issues](https://github.com/negue/meme-box/labels/good%20first%20issue)
* [Open for Contribution](https://github.com/negue/meme-box/labels/open%20for%20contribution)
* [Developers Sanity](https://github.com/negue/meme-box/labels/developers%20sanity)
* or all other Issue, in case I missed to label them: https://github.com/negue/meme-box/issues
* Star it :)
[`Getting started with Development`](README_DEV.md)
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Aaron Rackley
💻
Salma @whitep4nth3r
💻 🤔 🎨
Igor Ilic
🐛 🤔 💻 📖
CrypticEngima
🎨
Oliver
🐛 💻
jonathanbucci
📖
Divyanshu Singh
💻
Brandon
💻
Chirag Mahawar
💻
Varun Khalate
💻
Dominik Nakamura
💻 📖 📦
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!