mpd/README.txt

 
### mpd Mod for Minetest
(c) 2017-2023 orwell96

Adds an easy but powerful background music backend.

NOTE: As of 2023-09, this mod comes without any music, since there have
been reports of copyright violations. Please add your own music, as
described below.

## Usage

For all players:

/mvolume <volume>
Set your individual music volume or disable background music
(/mvolume 0). Saved across server restarts.

/mpd_list: list available music

With mpd privilege:

/mpd_play <id>: play a song

/mpd_stop: stop the current song. Unless /mpd_play or /mpd_next are
invoked, no more music is played

/mpd_next [time]: Play the next song after [time] seconds,
immediately if omitted.


## Votes

This mod integrates with the [vote] mod by rubenwardy
(https://github.com/minetest-mods/vote)

/vote_mpd_next - vote to start next song

/vote_mpd_play <id> - Vote to play certain sing


## Adding music

To add your own music, you must provide the sound files.

1. Convert the sound files to OGG format (for example using Audacity)
2. Place the sound file in the sounds/ directory
3. Insert a new line into songs.txt

Lines in songs.txt must contain the filename of the file in the sounds
folder (without the .ogg extension), the length of the song, a gain
value and a human-readable title, each separated by whitespace
character. Using one "Tab" is recommended. See the example line.

The gain is a value between 0.0 and 1.0, where 1.0 means full volume.
It can be used to make all songs equally loud when they have different
volumes.

When recording videos e.g. for youtube, please make sure that you have
permission to perform the song in the video and do not break any
copyright law.

## License

Copyright (C) 2017-2023  orwell96

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.