Skip to content

Library and API for Multimedia, Powered by LibVLC. Working on pure JAVA and all Minecraft Modloaders

Notifications You must be signed in to change notification settings

WaterMediaTeam/watermedia

Repository files navigation

CurseForge JitPack Modrinth Version
CurseForge downloads Minecraft versions supported

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

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:<version>'
}

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

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

MAINTAINERS

CONTRIBUTORS

SHADED DEPENDENCIES

Important: All libraries are relocated and wrapped using shadowJar.

NO SHADED DEPENDENCIES

  • LWJGL
  • jna
  • jna-platform
  • gson
  • log4j-api
  • log4j-core