Description

Sound Library Api allows you to store & play recorded sounds for players, attach them to npcs, trigger them via in-game events

Use Sound Library API Encoder which allows you to convert any audio file to our own format (after converting the file, rename it and move it to /data/SoundLibraryApi):

Sound Library Encoder

Configuration:

{
"Scheduled message interval (seconds)": 900.0,
"Speaker Distance (The higher the number, the further away is the speaker resulting in a quieter voice)": 5.0,
"Audio events": {
"ScheduledMessage": {
"Enable audio event": true,
"Global audio event (set false in order to be heard only by the player that triggered the audio event)": true,
"Audio files": [
"placeholder1",
"placeholder2"
]
},
"Welcome": {
"Enable audio event": true,
"Global audio event (set false in order to be heard only by the player that triggered the audio event)": false,
"Audio files": [
"placeholder1",
"placeholder2"
]
},
"PatrolHelicopter": {
"Enable audio event": true,
"Global audio event (set false in order to be heard only by the player that triggered the audio event)": true,
"Audio files": [
"placeholder1",
"placeholder2"
]
},
"Airdrop": {
"Enable audio event": true,
"Global audio event (set false in order to be heard only by the player that triggered the audio event)": true,
"Audio files": [
"placeholder1",
"placeholder2"
]
},
"CargoShip": {
"Enable audio event": true,
"Global audio event (set false in order to be heard only by the player that triggered the audio event)": true,
"Audio files": [
"placeholder1",
"placeholder2"
]
},
"Chinook": {
"Enable audio event": true,
"Global audio event (set false in order to be heard only by the player that triggered the audio event)": true,
"Audio files": [
"placeholder1",
"placeholder2"
]
},
"CrateHack": {
"Enable audio event": true,
"Global audio event (set false in order to be heard only by the player that triggered the audio event)": false,
"Audio files": [
"placeholder1",
"placeholder2"
]
},
"MissionStarted": {
"Enable audio event": true,
"Global audio event (set false in order to be heard only by the player that triggered the audio event)": false,
"Audio files": [
"placeholder1",
"placeholder2"
]
},
"MissionFinished": {
"Enable audio event": true,
"Global audio event (set false in order to be heard only by the player that triggered the audio event)": false,
"Audio files": [
"placeholder1",
"placeholder2"
]
},
"MissionFailed": {
"Enable audio event": true,
"Global audio event (set false in order to be heard only by the player that triggered the audio event)": false,
"Audio files": [
"placeholder1",
"placeholder2"
]
}
}
}

Language:

{
"NoPermission": "<color=#e3e3e3>You do not have permission to use this command",
"AlreadyRecording": "<color=#e3e3e3>You're already recording. Please save or cancel your previous recording before starting a new one.",
"InvalidAddSyntax": "<color=#e3e3e3>Invalid Syntax. Ex: <color=#de8732>/sl add soundname",
"AddAlreadyExists": "<color=#e3e3e3>This sound already exists. <color=#e3e3e3>Please add <color=#de8732>overwrite to your arguments to allow overwriting an existing sound.<color=#e3e3e3>Ex: <color=#de8732>sl add {{0}} overwrite",
"AddRecording": "<color=#e3e3e3>You can now start recording.n<color=#e3e3e3>The recording will automatically start once your start sending audio.n<color=#e3e3e3>Once you have completed you can use <color=#de8732>/sl save or <color=#de8732>/sl cancel.n<color=#e3e3e3>You can listen to your recording using <color=#de8732>/sl playn<color=#e3e3e3>If you want to rerecord your recording use <color=#de8732>/sl reset",
"NotRecording": "<color=#e3e3e3>You're not currently recording.",
"RecordingSaved": "<color=#e3e3e3>We have saved your recording as '{0}'",
"CanceledRecording": "<color=#e3e3e3>We have canceled your recording",
"ResetRecording": "<color=#e3e3e3>Your recording has been reset.",
"PlayInvalidSyntax": "<color=#e3e3e3>Invalid Syntax. Ex: <color=#de8732>/sl play soundname - to play the sound with the given name.",
"NoSoundFileFound": "<color=#e3e3e3>No sound file found with name '{0}'",
"HelpText": "<color=#e3e3e3>Allows players to record sound that can be played back to a playern<color=#de8732>/sl add soundname - to start the creation of a new sound.n<color=#de8732>/sl npc add hookActionType fileName - to add one or more filenames to a human npc (hook action types are: <color=#de8732>OnUseNPC/OnEnterNPC/OnLeaveNPC/OnHitNPC)n<color=#de8732>/sl npc remove hookActionType fileName - to remove a filename from a human npc (hook action types are: <color=#de8732>OnUseNPC/OnEnterNPC/OnLeaveNPC/OnHitNPC)n<color=#de8732>/sl save - to save your recorded sound.n<color=#de8732>/sl reset - to clear your current recording.n<color=#de8732>/sl cancel - to cancel your recording and not save.n<color=#de8732>/sl play - to player your current recording back to you.n<color=#de8732>/sl - to view this help text again.",
"AudioMessagesHelpText": "<color=#e3e3e3><color=#66B2FF>/audio send playerName audioName - Sends an audio message to a playern<color=#e3e3e3><color=#66B2FF>/audio sendall audioName - Sends an audio message to everyone on the servern<color=#e3e3e3><color=#66B2FF>/audio sendlooped playerName audioName 2 (loop times amount) - Sends a looped audio message to a playern<color=#e3e3e3><color=#66B2FF>/audio sendalllooped audioName 2 (loop times amount) - Sends a looped audio message to everyone on the servern<color=#e3e3e3><color=#66B2FF>/audio files - Shows a list of all audio files on the servern<color=#e3e3e3><color=#66B2FF>/sl - Shows the help page for the Sound Library APIn<color=#e3e3e3><color=#66B2FF>/audio help - Shows these help messages",
"PlayingText": "<color=#e3e3e3>Playing the file with the name of <color=#de8732>{0}",
"PlayingAudioMessageText": "<color=#e3e3e3>Playing the file with the name of <color=#66B2FF>{0}",
"InvalidTarget": "<color=#e3e3e3>Invalid target, try using his steamid/name",
"NullFileName": "<color=#e3e3e3>This file name is null, use /audio files",
"AvailableFileNames": "<color=#e3e3e3>Available files:n<color=#66B2FF>{0}",
"FileNameNotFound": "<color=#e3e3e3><color=#66B2FF>{0} does not exist, use <color=#66B2FF>/audio files",
"NpcNotFound": "<color=#e3e3e3>Couldn't find any human npc, make sure you have created one using <color=#de8732>/npc_add and you are looking at it!",
"InvalidHookActionType": "<color=#e3e3e3><color=#de8732>{0} is invalid, list of hook action types:<color=#de8732>nOnUseNPCnOnEnterNPCnOnLeaveNPCnOnHitNPC",
"NpcSoundAdded": "<color=#e3e3e3><color=#de8732>{0} was added and will play when <color=#66B2FF>{1} is triggered",
"NpcSoundRemoved": "<color=#e3e3e3><color=#de8732>{0} was removed from this NPC!",
"FileNameAlreadyAdded": "<color=#e3e3e3><color=#de8732>{0} was already added to this NPC!"
}

Human NPC Integration example:

{
"Npc Data": {
"303133854": {
"Action type of the npc & Filenames that are played": {
"OnUseNPC": [
"testing",
"testing"
]
}
},
"986905907": {
"Action type of the npc & Filenames that are played": {
"OnEnterNPC": [
"testing"
]
}
},
"1543143931": {
"Action type of the npc & Filenames that are played": {
"OnHitNPC": [
"messagesound"
]
}
},
"1205925446": {
"Action type of the npc & Filenames that are played": {
"OnUseNPC": [
"testing",
"pop"
],
"OnHitNPC": [
"testing"
]
}
},
"45461627": {
"Action type of the npc & Filenames that are played": {
"OnUseNPC": [
"messagesound"
],
"OnHitNPC": [
"messagesound"
]
}
},
"942954162": {
"Action type of the npc & Filenames that are played": {
"OnHitNPC": [
"waveeffect",
"messagesound"
],
"OnEnterNPC": [
"messagesound"
]
}
}
}
}

Recording & Playing Audio Files Video:

Human NPC Integration Video:

Permissions:

soundlibraryapi.use – In order to use /sl

soundlibraryapi.audio – In order to use /audio

Console Command:
audio.message

Important:

Does the audio played by the npc stutters or skips frames? Make sure you recorded the audio with the volume being as high as possible and the server does not perform poorly, there are cases where a server lags and the voice data losses quality/stutters