Skip to content

Latest commit

 

History

History
251 lines (164 loc) · 9.36 KB

README.md

File metadata and controls

251 lines (164 loc) · 9.36 KB
Raw

pmms - FiveM/RedM synchronized media player

pmms (Poodle's MultiMedia System) allows players to play music/video from entities such as phonographs, radios or TVs.

Features

  • NUI-based, using MediaElement.js to support HTML5 media, HLS, YouTube, and more.

  • Synchronized between players.

  • Multiple entities can play different things at the same time.

  • Dynamic sound attenuation based on whether the player and entity are in the same interior room.

  • Optional immersive filter can be applied to any audio.

  • Play video on a TV screen or scaleform with DUI (FiveM), or on a screen displayed above the entity (RedM).

  • Play audio inside or outside of vehicles.

  • Permissions system and ability to lock entities so only certain players can control them.

  • Configure default entities which are spawned and play music/video automatically.

  • Audio visualizations via Wave.js.

Examples
Attenuation Example Phonograph Filter Video
FiveM basic audio FiveM DUI example DUI render target proximity
Audio Visualizations Vehicle modes Scaleform adjustment

Dependencies

Installing

  1. Install all dependencies.

  2. Place the files from this repository in a new folder in your resources directory.

    Example: resources/[local]/pmms

    NOTE

    The name of the resource must be in all lowercase in order for it to function properly. This is due to how NUI callbacks work.

  3. Add the following in server.cfg:

    exec @pmms/permissions.cfg
start pmms

Permissions

The default permissions allow members of group.admin full access to pmms, while other players will only be able to perform basic interactions with media players and only be able to play preset songs (those defined in Config.presets in config.lua).

To allow all players to be able to play custom URLs, in permissions.cfg, uncomment or add the following line:

add_ace builtin.everyone pmms.customUrl allow

Even with this ace, URLs will be restricted to those allowed by Config.allowedUrls, which includes generally safe sites such as YouTube. To allow players to use URLs from other sites, you can either add the appropriate pattern to Config.allowedUrls, or uncomment or add the following line to remove the restriction entirely:

add_ace builtin.everyone pmms.anyUrl allow

Keep in mind that media played with pmms is loaded individually by all players, meaning each player will be accessing the URL from their own connection. Therefore, allowing any player to play a random URL can present some risk of exposing players' IP addresses to an attacker playing something from their own web server and logging the connections.

Commands

Note

The command names can be customized. These are the defaults.

Command Description
/pmms Open the media player control panel.
/pmms_play [url] ... Play music/video on the nearest media player.
/pmms_pause Pause playback on the nearest media player.
/pmms_stop Stop playback on the nearest media player.
/pmms_status Show the status of the nearest media player.
/pmms_presets List presets.
/pmms_vol [volume] Set a personal base volume for all media players.
/pmms_fix Reset your client, which may fix certain issues.
/pmms_ctl Advanced media player control.
/pmms_add Add or modify a media player model preset.
/pmms_refresh_perms Refresh permissions for all clients.

Exports

Server-side

startByNetworkId

handle = exports.pmms:startByNetworkId(netId, options)

Starts playing something on a networked media player entity, using its network ID.

Media player options

options is a table of options for the new media player.

Option Description
url The URL of the media to play.
title The title of the media to display.
volume The volume of the new media player. Default: 100.
offset The time to start the media at in seconds. Default: 0.
duration The duration of the media. nil, false or 0 will treat the media as a live stream.
loop Whether to loop the media. Requires a duration.
filter Whether to apply the immersive filter to the media player.
locked Whether to lock the media player.
video Whether to display NUI video (RedM only).
videoSize The size of the NUI video screen (RedM only).
muted Whether the media player is muted by default.
attenuation The attenuation multipliers for the media player.
diffRoomVolume Difference between the base volume in the same room and a different room.
range The range of the media player.
visualization The audio visualization to apply to the media player.

startByCoords

handle = exports.pmms:startByCoords(x, y, z, options)

Starts playing something on a non-networked media player entity, using its coordinates on the world map.

For options, refer to Media player options.

startScaleform

handle = exports.pmms:startScaleform(scaleform, options)

Starts playing something on a standalone scaleform screen.

For options, refer to Media player options.

Scaleform options

scaleform is a table of options for the scaleform screen.

Option Description
name The name of the scaleform (.gfx filename minus extension).
position A vector3 for the coordinates of the top-left of the screen.
rotation A vector3 for the orientation of the screen.
scale A vector3 for the scale of the screen.

stop

exports.pmms:stop(handle)

Stops a media player and removes its handle.

pause

exports.pmms:pause(handle)

Pause or resume a media player.

lock

exports.pmms:lock(handle)

Locks an active media player so that only privileged users can interact with it.

unlock

exports.pmms:unlock(handle)

Unlocks an active media player so anyone can interact with it.

mute

exports.pmms:mute(handle)

Mutes an active media player.

unmute

exports.pmms:unmute(handle)

Unmutes an active media player.

Client-side

enableEntity

exports.pmms:enableEntity(entity)

Allows the player to use a particular entity if they do not have the pmms.anyEntity ace.

disableEntity

exports.pmms:disableEntity(entity)

Disables the use of this entity for a player without the pmms.anyEntity ace.

createMediaPlayer

entity = exports.pmms:createMediaPlayer(options)

Creates a new networked entity which the player can use as a media player.

createMediaPlayer options

Option Description
model The entity model to use. If omitted, Config.defaultModel will be used.
position A vector3 for the coordinates where the entity will be spawned.
rotation A vector3 for the orientation of the entity.

deleteMediaPlayer

exports.pmms:deleteMediaPlayer(entity)

Deletes an entity created by createMediaPlayer.