README.md

Meme-Box | Getting Started | How to contribute

A complete management app for image / audio / video / iframe / widgets "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! (currently a bit ouf of date, new release soon) - latest nightly Builds

From source

If you would like to build MemeBox from source, have a look at our dedicated BUILD.md.

From AUR

If you're an Arch Linux user, you can install directly from the AUR, using one of the AUR helpers.

For example, with paru:

paru -S memebox

Working Features

Show Media	Screens (in OBS)	Triggers
Images	Animations on show / hide Visibility: Play (on a trigger) Toggle (per trigger) Always Visible Custom Position per Media / Screen: Fullscreen Fixed (on a position) Centered Random Misc: Custom CSS per Media / Screen drag&drop for better position items rotate/size/warp items	✅ Streamdeck Plugin ✅ Deckboard Plugin ✅ 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
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
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!

Installation and Getting Started

Advanced:

• Trigger multiple / randoms
• Screen / Media Settings
• Scripts
• Widgets

---

Roadmap

2023.1 (maybe 2024.1, depending how long it takes)

• Main Feature: Refactor Trigger System / Config
  • Easier way to add more types of triggers
  • Also adds the command blocks per trigger (easier way to just "do" stuff)

Dependencies for that: ^

• #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

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
  • Open for Contribution
  • Developers Sanity
  • or all other Issue, in case I missed to label them: https://github.com/negue/meme-box/issues
• Star it :)

Getting started with Development

Contributors ✨

Thanks goes to these wonderful people (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 specification. Contributions of any kind welcome!