Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/watermediateam/watermedia
Library and API for Multimedia, Powered by LibVLC. Working on pure JAVA and all Minecraft Modloaders
https://github.com/watermediateam/watermedia
api api-client fabric forge libvlc minecraft minecraft-forge minecraft-mod minecraftforge multimedia multimedia-player neofabric neoforge quiltmc quiltmc-mod videolan vlc vlcj vlcj-natives
Last synced: about 2 months ago
JSON representation
Library and API for Multimedia, Powered by LibVLC. Working on pure JAVA and all Minecraft Modloaders
- Host: GitHub
- URL: https://github.com/watermediateam/watermedia
- Owner: WaterMediaTeam
- Created: 2023-05-05T08:28:16.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-08T04:05:05.000Z (7 months ago)
- Last Synced: 2024-06-10T04:29:07.556Z (7 months ago)
- Topics: api, api-client, fabric, forge, libvlc, minecraft, minecraft-forge, minecraft-mod, minecraftforge, multimedia, multimedia-player, neofabric, neoforge, quiltmc, quiltmc-mod, videolan, vlc, vlcj, vlcj-natives
- Language: Java
- Homepage:
- Size: 324 MB
- Stars: 9
- Watchers: 2
- Forks: 8
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
[](https://www.curseforge.com/minecraft/mc-mods/watermedia/files)
[](https://jitpack.io/#SrRapero720/watermedia)
[](https://modrinth.com/mod/watermedia)
[](https://www.curseforge.com/minecraft/mc-mods/watermedia)
[](https://www.curseforge.com/minecraft/mc-mods/watermedia/files)
[](https://discord.gg/cuYAzzZ)
[](https://discord.gg/453QZ749U4)
# WATERMeDIA | MULTIMEDIA API
API-Library providing multimedia support using LibVLC, used by Minecraft mods like VideoPlayer.
Designed to be used in pure Java and Minecraft environments using MinecraftForge (NeoForge) and Fabric (Quilt).
our API provides an extra layer of VLCJ MediaPlayers making easier player management,
async task and concurrency.
Custom ``URLFixers`` to provide support of platforms like YouTube, Twitch,
Kick.com, Google Drive, OneDrive, Dropbox, Imgur, Twitter and PornHub.
## VERSION STATUS
WATERMeDIA can be loaded in any MC version in range of 1.16.5 ~ 1.21.x and
outside Minecraft adding the proper dependencies.
> [!IMPORTANT]
> We only support the most popular versions of Minecraft.
| Version | Forge | Fabric | NeoForge |
|:-------:|:-----:|:------:|:--------:|
| 1.16.5 | 🚨 | 🚨 | 🚫 |
| 1.18.2 | ✅ | ✅ | 🚫 |
| 1.19.2 | ✅ | ✅ | 🚫 |
| 1.20.1 | ✅ | ✅ | ✅ |
| 1.20.x | ✅ | ✅ | ⛔ |
| 1.21.1 | ✅ | ✅ | ✅ |
✅ - **SUPPORTED** ||| ⚠ - **PLANNED** ||| ⛔ - **NOT SUPPORT** ||| 🚫 - **N/A** ||| 🚨 - **DROPPING**
# INSTALLATION
We use JitPack.io to build and distribute artifacts using direct GitHub tags or branches.
Check all available versions here: https://github.com/WaterMediaTeam/watermedia/tags
**IN YOUR GRADLE**
```gradle
repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
// doesn't require fg.debof() or any debofuscation tool
// watermedia is minecraft-agnostic (we don't believe in notch, or agnes)
implementation 'com.github.WaterMediaTeam.watermedia:build:'
}
```
# VIDEOLAN OS SUPPORT
Our API is based in pure JAVA, except video decoding; we use VideoLAN for that.
It requires VideoLan (libVLC) binaries to load and use video features.
We feature on Windows x64 a pre-installation of VLC in our JAR,
so they don't have to download it manually.
But some OS+Arch requires manual installation of VLC,
and others aren't supported by VLC limitations.
Ensure your OS is supported in this list.
Linux users: check https://www.videolan.org/vlc/#download
> [!WARNING]
> FLATPAK is not supported (or any archlinux thing), use apt-get or manual installation for VLC and Minecraft (or any game)
> [!WARNING]
> MacOS should install universal arch version (avoiding arch concerns)
> Download the universal version [here](https://get.videolan.org/vlc/3.0.21/macosx/vlc-3.0.21-universal.dmg)
| Operative System | Support status |
|:----------------:|:--------------:|
| Win 1x (x64) | ✅ |
| Win 1x (x32) | ⛔ |
| Win 1x (ARM) | 🚫 |
| MacOS (x64) | ❎ |
| MacOS (ARM) | ❎ |
| Linux (x64) | ❎ |
| Linux (ARM) | ❎ |
| Android (Pojav) | ⚠ |
- ✅ **SUPPORTED**
- ❎ **LIMITED:** Needs manually VLC 3 installation
- ⚠ **PLANNED:** Requires some research
- 🚫 **NOT COMPATIBLE:** Due to VLC limitations
- ⛔ **UNSUPPORTED:** Not even planned
# Projects using WATERMeDIA
- [WATERFrAMES](https://www.curseforge.com/minecraft/mc-mods/waterframes) - By SrRapero720
- [VideoPlayer](https://www.curseforge.com/minecraft/mc-mods/video-player) - By NGoedix
- [LittlePictureFrames](https://www.curseforge.com/minecraft/mc-mods/littleframes) - By CreativeMD
- [PictureSign](https://www.curseforge.com/minecraft/mc-mods/picturesign) - By Motschen (TeamMidnightDust)
- [Nightmare Craft](https://www.curseforge.com/minecraft/modpacks/nightmare-craft-chapter-1) By divinegaminginc
- [FancyMenu (Coming Soon)](https://legacy.curseforge.com/minecraft/mc-mods/fancymenu) - By Keksuccino
# MAINTAINERS
- [SrRapero720](https://github.com/SrRapero720) - Donations: https://paypal.me/SrRapero720
- [NGoedix](https://github.com/NGoedix) - Donations: https://paypal.me/ngoedix
# CONTRIBUTORS
- [zenoarrows](https://github.com/ZenoArrows) - Buffer Eater
- [cyyynthia](https://github.com/cyyynthia) - Deadlock hunter
# SHADED DEPENDENCIES
**Important:** All libraries are relocated and wrapped using shadowJar.
- [VLCJ](https://github.com/caprica/vlcj/tree/vlcj-4.x)
- [Java-youtube-downloader](https://github.com/sealedtx/java-youtube-downloader)
- [Jackson Databind](https://github.com/FasterXML/jackson-databind)
- commons-io
- commons-lang3
- commons-codec
# NO SHADED DEPENDENCIES
- LWJGL
- jna
- jna-platform
- gson
- log4j-api
- log4j-core