Inactive [FUN] AmbientSpout WIP v1.0.2 - Custom ambient music & Looping sound effects[SPOUT] [1.2.5-R4.0]

Discussion in 'Inactive/Unsupported Plugins' started by Rahazan, Dec 23, 2011.

  1. Offline

    Rahazan

    Fully rewritten
    AmbientSpout

    Download: <Edit by Moderator: Redacted bit url>



    Show Spoiler
    How to setup

    ------------
    Step 1 - Configuration:
    - Start your server with the plugin installed. The plugin will generate the necessary files for you.
    - Shut down your server and change config.yml to your likings.

    ------------
    Step 2 - Adding music:
    There are two ways of adding music (or sounds). Either, you make use of the built-in webserver, or you provide links to where the music can be found.
    You can use both methods simoultaneously.


    << Built-in Webserver >>

    With this method, you place your sounds in a specific folder (probably AmbientSpout/Resources/Ambient or AmbientSpout/Resources/EffectLoop).

    For .wav files: Simply drag and drop them in.
    For .ogg files: Make the last 3 characters of the filename the length of the song in seconds. Say the song (or sound) is 1 min 32 long, 1*60sec + 32 = 92.
    You name your file music092.ogg (or whichever other name you like).

    Note that using the webserver will use bandwidth of your server.



    << Providing Links >>

    In AmbientSpout/Resources you can find Ambient.txt. In this file, you can add links to sound files. Add them in this format, one per line:
    <SONGLENGTH> <LINK>

    Example:
    123 http://google.com/song.ogg

    NOTE: The link has to be a non-secure HTTP link, so not https://. I am saying this because DropBox gives https:// links nowadays, just remove the s at the end :).

    Providing links is suggested (instead of webserver) if you fear the upload speed of your server is not the best, or you pay per bandwidth use.

    ------------
    Step 3 - OPTIONAL: Configuring WebServer:
    In case you want to make use of the built-in webserver, you will have to configure it.
    In config.yml you have to add configure these fields:
    HostAdress: Your host address (most likely the sameas the IP of the minecraft server.
    HostPort: The port you want the webserver to run on (the default should be just fine in most cases).
    EnableWebServer: Boolean value, do you want to use the webserver (you probably do, as you are reading this).

    Example:
    HostAdress: myawesomeserver.minecrafthost.com
    HostPort: 5651
    EnableWebServer: true

    >?> How do I know if the webserver is working?
    Everything in the Resources folder is hosted. Because Ambient.txt is always present, try to go to this address:
    http://HostAdress:HostPort/Ambient.txt

    Example:
    http://myawesomeserver.minecrafthost.com:5651/Ambient.txt

    If you see the contents of your Ambient.txt file, then congratulations, it's working! (Note that Ambient.txt may be empty if you didn't add anything to it.)



    "="-key is used to open the overlay by default.

    A collection of posts about the functionality + configuration:

    [quote uid=1858 name="Rahazan" post=46027]Started working on it yesterday, +8 hours in I have the following features fully working:
    - Webserver to host songs built-in (drag n drop your music files in a folder).
    - Song looping.
    - Song fadeout (all-ready for area transition).
    - Song playback & end.
    - Customizable player image.

    If anyone is interested in the current version, I can put it up here with a few instructions..
    Screenshots:

    [​IMG]
    Resources
    [​IMG]
    Configuration
    [​IMG]

    It will automatically find out the length of .wav files, unfortunately this is not possible (without adding an external library that is +100MB big) to do this automatically for .ogg files.
    The easiest solution I found, is to put the duration of the ogg file in the name itself. The last 3 digits indicate the length in seconds.[/quote]

    [quote uid=1858 name="Rahazan" post=46040]For those that would like to try & test what has been implemented so far:
    http://bit.ly/MK1siY

    "="-key is used to open the screen.
    Put .ogg files in AmbientSpout/Resources/Ambient.
    Last 3 characters of ogg filename must be the song length in seconds.

    NOTE: Currently does not save player-data between server resets. So if a player disables music, and the server restarts, and the player starts again, it will be enabled (if DefaultOn is set to true, that is).

    A little bit about the config:
    Delaybetweensongs: that should be pretty clear. Delay between songs advised +30sec
    DelayRandomness: Say you have 10 as delay, and 2 as randomness, the actual delay will be between 8 and 12 seconds.
    FadeOutLength: Pretty straight-forward
    DefaultOn: Do players start with music on when they (first) join?
    MusicAreaEnabled: Not implemented yet, no effect.
    DevMessage: Please keep this set on true, in case I join ;3
    UseBackgroundImage: Whether you want to use a background image. Note: No need to worry about it overlapping the buttons, it will ALWAYS be in the back. Can be jpg or png, and can be transparent. For fullscreen: 427 by 240 pixels.
    BackgroundImage: Link to the image you want to use.
    EnableWebServer: Leave this on true, as it is the only way to have music :p, a list will probably be implemented later (so you can host files elsewhere, like the old AmbientSpout)
    HostAddress: Put your server IP or hostname here.
    HostPort: Pick a port you like ;)

    Yey
    [/quote]
    [quote uid=1858 name="Rahazan" post=46028]Update, sometime in the future. Full rewrite[/quote]
    [quote uid=1858 name="Rahazan" post=46592]http://bit.ly/MK1siY
    New version up!

    EffectLoops are effects that can be added quite easily to a specific place. For example, Seagull sounds in a harbor, waterfall sounds near a waterfall ;). As the name implies, they loop.

    A few more things about new features..
    -One can now add non-webserver sounds by adding lines to a text file, the first number indicating the length of said sound file.
    [​IMG]

    - It now remembers whether or not the user has music enabled.
    - Effectloops are saved in human-readable form, so one can easily edit it/add to it from outside.
    [​IMG]
    In order:
    * ID (string name to be able to recognize said effectloop)
    * Length in seconds
    * URL
    * X coord
    * Y coord
    Z coord
    * Worldname
    * VolumePercent
    * Distance it can be heard from
    * Active (enabled or not)

    - Added metrics
    - Quite a lot of performance improvements..


    << Note, you are going to have to add the effectloops manually for now, haven't finished the GUI for that yet ;). The future permission node: ambientspout.admin > This will already show a button to go to the effectloops management screen.[/quote]


    [quote uid=1858 name="Rahazan" post=46592]http://bit.ly/MK1siY
    New version up!

    EffectLoops are effects that can be added quite easily to a specific place. For example, Seagull sounds in a harbor, waterfall sounds near a waterfall ;). As the name implies, they loop.

    A few more things about new features..
    -One can now add non-webserver sounds by adding lines to a text file, the first number indicating the length of said sound file.
    [​IMG]

    - It now remembers whether or not the user has music enabled.
    - Effectloops are saved in human-readable form, so one can easily edit it/add to it from outside.
    [​IMG]
    In order:
    * ID (string name to be able to recognize said effectloop)
    * Length in seconds
    * URL
    * X coord
    * Y coord
    Z coord
    * Worldname
    * VolumePercent
    * Distance it can be heard from
    * Active (enabled or not)

    - Added metrics
    - Quite a lot of performance improvements..


    << Note, you are going to have to add the effectloops manually for now, haven't finished the GUI for that yet ;). The future permission node: ambientspout.admin > This will already show a button to go to the effectloops management screen.[/quote]


    Show Spoiler
    [quote uid=919 name="Mysteana" post=46600]That sounds *badum tish* really great. Looping ambient sounds have been wanting for a very long time... that'll also cut the file sizes considerably since you don't need a 15+ minute audio streams like with the old discontinued ambient sounds plugin on Bukkit (back when Spout was still BukkitContrib)

    I was wondering if you could possibly extend the parameters to include a 'begin looping' time point so that you can have an 'intro' segment before the sound goes into its loop section. I'm fairly sure at the very least admins with RPG servers with dungeons and towns will love you for that ;)[/quote]

    MusicArea's (to be implemented) will have such a feature if you feel like it's a useful feature :). The current sound effects are really meant for ambient sound EFFECTS, but there is no reason it shouldn't work for some gregorian music in a cathedral ;), or a greensleeves song in a tavern :p.

    Currently, the sound effects work in a certain fashion: The custom sound effect is played for everybody in the server at the same time, to reduce the resources the plugin needs dramatically. A downside to this is that if you join the server, you may not hear the ambient sound effect yet, as you must wait for the next custom sound effect to play for you.

    The way I currently implemented it: If you join a server, and you are not in a sound area, it will play the sound effect anyhow (for you personally). So there is a possibility, that if you just join a server, walk into a different effectloop area, your personal & the global sound effect will overlap.. I have thought of making them per-user, but I think that just won't be worth the resources for that unlikely problem ;).

    Because they are global, I can not make an intro, after which it goes into loop-mode. For MusicArea's this will be possible though. I will try to make them as configurable as is desired by server hosts :).







    Show Spoiler
    AmbientSpout
    <Edit by Moderator: Redacted bit url>

    This plugin adds custom ambient music to your server. Players can turn this on and off. There is also a widget that is toggle-able and the possibility for users to use their own music link. After a song has stopped playing, the next song will start.

    Demonstration of this plugin.


    How to use:
    In config.yml you find a list, which is initially empty, where you enter the following information; the duration of the song and the link to it. The format can only be .ogg or .wav ! You can add as many songs as you like.

    Example config.yml
    Code:
    DebugMode: false
    Ambient:
    - 146 http://dl.google.com/u/JustAnExample.ogg
    - 169 http://dl.google.com/u/JustAnotherExample.ogg
    - 123 http://dl.google.com/u/JustAnotherExampleAgain.ogg
    Dependencies:
    * Spout serverside.
    * SpoutCraft clientside(if the player wants to use this plugin).

    Features:
    * Easy to configure.
    * Lightweight.
    * Permissions-based.
    * Hotkey configurable in SpoutCraft

    Downloads:
    <Edit by Moderator: Redacted bit url>


    Show Spoiler
    How does it help my plugin?
    Plugin-wise, in absolutely no way.

    Then why on Earth would I donate?
    Time and effort was put into this plugin. Maybe this plugin makes your life easier, gets your server more players or simply makes you and the players have a good time.
    How do I donate?
    You can donate through PayPal. If you do not have the means to do so, you can also "donate" by showing your appreciation in the form of a nice comment. These donations and comments keep me motivated. Oh, and it keeps me alive in this overpriced studentroom I live in. It means the world to me.

    Thank you for reading this.




    Changelog
    Version 0.1
    * Initial release.

    Any feedback is more than welcome!
     
    Last edited by a moderator: Feb 20, 2017
  2. Offline

    TheCoCe

    Ok it work's now... But wav files do not work :(
    And what about add playlist's?
     
  3. Offline

    ChrisX930

    Is it possible to make Regional-Music?
    For Example: You enter the Region "Cubecity", the plugin should play "cubecity.ogg" for the player.
    When the player leave this location, the music will stop.
     
  4. Offline

    bloobblop

    dosent work at all . fully loaded & your web address for wem music is NULL
     
  5. Offline

    donald1440

  6. Offline

    wolfenit415

    [quote uid=46334 name="Rahazan" post=873233]Fully rewritten
    AmbientSpout

    Download: <Edit by Moderator: Redacted bit url>



    Show Spoiler
    How to setup

    ------------
    Step 1 - Configuration:
    - Start your server with the plugin installed. The plugin will generate the necessary files for you.
    - Shut down your server and change config.yml to your likings.

    ------------
    Step 2 - Adding music:
    There are two ways of adding music (or sounds). Either, you make use of the built-in webserver, or you provide links to where the music can be found.
    You can use both methods simoultaneously.


    << Built-in Webserver >>

    With this method, you place your sounds in a specific folder (probably AmbientSpout/Resources/Ambient or AmbientSpout/Resources/EffectLoop).

    For .wav files: Simply drag and drop them in.
    For .ogg files: Make the last 3 characters of the filename the length of the song in seconds. Say the song (or sound) is 1 min 32 long, 1*60sec + 32 = 92.
    You name your file music092.ogg (or whichever other name you like).

    Note that using the webserver will use bandwidth of your server.



    << Providing Links >>

    In AmbientSpout/Resources you can find Ambient.txt. In this file, you can add links to sound files. Add them in this format, one per line:
    <SONGLENGTH> <LINK>

    Example:
    123 http://google.com/song.ogg

    NOTE: The link has to be a non-secure HTTP link, so not https://. I am saying this because DropBox gives https:// links nowadays, just remove the s at the end :).

    Providing links is suggested (instead of webserver) if you fear the upload speed of your server is not the best, or you pay per bandwidth use.

    ------------
    Step 3 - OPTIONAL: Configuring WebServer:
    In case you want to make use of the built-in webserver, you will have to configure it.
    In config.yml you have to add configure these fields:
    HostAdress: Your host address (most likely the sameas the IP of the minecraft server.
    HostPort: The port you want the webserver to run on (the default should be just fine in most cases).
    EnableWebServer: Boolean value, do you want to use the webserver (you probably do, as you are reading this).

    Example:
    HostAdress: myawesomeserver.minecrafthost.com
    HostPort: 5651
    EnableWebServer: true

    >?> How do I know if the webserver is working?
    Everything in the Resources folder is hosted. Because Ambient.txt is always present, try to go to this address:
    http://HostAdress:HostPort/Ambient.txt

    Example:
    http://myawesomeserver.minecrafthost.com:5651/Ambient.txt

    If you see the contents of your Ambient.txt file, then congratulations, it's working! (Note that Ambient.txt may be empty if you didn't add anything to it.)



    "="-key is used to open the overlay by default.

    A collection of posts about the functionality + configuration:











    Show Spoiler
    MusicArea's (to be implemented) will have such a feature if you feel like it's a useful feature :). The current sound effects are really meant for ambient sound EFFECTS, but there is no reason it shouldn't work for some gregorian music in a cathedral ;), or a greensleeves song in a tavern :p.

    Currently, the sound effects work in a certain fashion: The custom sound effect is played for everybody in the server at the same time, to reduce the resources the plugin needs dramatically. A downside to this is that if you join the server, you may not hear the ambient sound effect yet, as you must wait for the next custom sound effect to play for you.

    The way I currently implemented it: If you join a server, and you are not in a sound area, it will play the sound effect anyhow (for you personally). So there is a possibility, that if you just join a server, walk into a different effectloop area, your personal & the global sound effect will overlap.. I have thought of making them per-user, but I think that just won't be worth the resources for that unlikely problem ;).

    Because they are global, I can not make an intro, after which it goes into loop-mode. For MusicArea's this will be possible though. I will try to make them as configurable as is desired by server hosts :).







    Show Spoiler
    AmbientSpout
    <Edit by Moderator: Redacted bit url>

    This plugin adds custom ambient music to your server. Players can turn this on and off. There is also a widget that is toggle-able and the possibility for users to use their own music link. After a song has stopped playing, the next song will start.

    Demonstration of this plugin.


    How to use:
    In config.yml you find a list, which is initially empty, where you enter the following information; the duration of the song and the link to it. The format can only be .ogg or .wav ! You can add as many songs as you like.

    Example config.yml
    Code:
    DebugMode: false
    Ambient:
    - 146 http://dl.google.com/u/JustAnExample.ogg
    - 169 http://dl.google.com/u/JustAnotherExample.ogg
    - 123 http://dl.google.com/u/JustAnotherExampleAgain.ogg
    Dependencies:
    * Spout serverside.
    * SpoutCraft clientside(if the player wants to use this plugin).

    Features:
    * Easy to configure.
    * Lightweight.
    * Permissions-based.
    * Hotkey configurable in SpoutCraft

    Downloads:
    <Edit by Moderator: Redacted bit url>


    Show Spoiler
    How does it help my plugin?
    Plugin-wise, in absolutely no way.

    Then why on Earth would I donate?
    Time and effort was put into this plugin. Maybe this plugin makes your life easier, gets your server more players or simply makes you and the players have a good time.




    How do I donate?
    You can donate through PayPal. If you do not have the means to do so, you can also "donate" by showing your appreciation in the form of a nice comment. These donations and comments keep me motivated. Oh, and it keeps me alive in this overpriced studentroom I live in. It means the world to me.

    Thank you for reading this.




    Changelog
    Version 0.1
    * Initial release.

    Any feedback is more than welcome!


    [/quote]
    So I've started using this plugin. Seems to work good although it seems to not play all the music. I'm using the link to drop box method.also wondering if I change the way the song name shows up?. I understand your no longer updating or programming but I just need a small amount of info. Thanks for any info you can give.
     
    Last edited by a moderator: Feb 20, 2017
  7. Offline

    paragonxx99

    It's stuck at downloading for like 2 hours. Please help! I have the port and ip on the config.yml!
     
  8. Offline

    |Anthony|

    I love this plugin! Really hope it continues!
     
  9. Offline

    wolfenit415

    I really hope this plugin continue to my players like using it!
     
  10. Offline

    craterface12

  11. Offline

    Lummox

    Please, update! :(

    But seeing the last time which entered ....

    Rahazan was last seen: Aug 10, 2012
     

Share This Page