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

Fully rewritten
AmbientSpout

Download: <Edit by Moderator: Redacted bit url>

Show Spoiler Hide 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:


Resources

Configuration


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 , 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.


- 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.

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.


- 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.

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 Hide 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 .

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 Hide 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 Hide 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!

 

This plugin minus the GUI interface can be found in spout essentials.

 

i got a friend to update the plugin, but how do i add music to the plugin?

 

...........

 

lol our update failed we are currently fixing, forget i asked on the add music part >.<

 

Update sometime soon, total rewrite.

For those that would like to try & test what has been implemented so far:
http://bit.ly/MK1siY

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

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.
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 , 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

PM (open) PM (close)

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

Amazing! Omg this great! i cant wait till you get the music on area implimented also do you mind if i make a video for this? like how to config and setup?

 

I'd love to see you make one Do note that configuration and setup MAY still change, ehh

 

Okay

 

Lol, Current song:Bowerstone, I'm a fable fanboy

 

I want a video before I try it.

 

Note that you have to enter your server IP @ HostAddress if you want to use the webserver .

Added a video demonstration

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

I am now testing it Thanks again for replying to my post!

 

Which server? I'll hop on for a few minutes .

 

The IP is voidwarrior.verygames.net I am currently starting my server from scratch due to some plugins kinda forcing me to, but your more than welcome to hop on.
What's your ign?

 

You should change the tittle to AmbientMusic or AmbientSounds(I don't know)If you want this accepted on spout,because there is a rule of Spout in the name.

 

I believe that is only for new plugins, although I will start mindstorming for a new name non-the-less. By "new" plugins, I mean plugins released after the announcement. Seeing as this was released christmas 2011, I am not really woried about it .

Found it

Maybe the name "Ambient" will do, although it may not be clear enough.. The plugin has always gone by the name AmbientSpout and is recognized by it here and there; a few thousand downloads of the old versions :/..

Hard to hop on when I'm not whitelisted, heh. My IGN is Rahazan, like here on the forums.

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

Alright. You should be whitelisted.

Haven't tested the sound effects but works like a charm! Definitely one of the best plugins out there.

EDIT by Moderator: merged posts, please use the edit button instead of double posting.

 

First of all, let me thank you for continuing development of the plugin. However as one person has stated already, my music can sometimes cut off. Just wondering if this was an issue that you were aware of?

 

With the SpoutAPI, there is currently no way of telling when a song has actually started. The plugin works like this:

The player starts a song (by joining / clicking next song / whatever) > a timer starts > the song is played > delay of song length + delay between songs > next song is played.
The problem here, is that the song may not yet be started when "the song is played", it may first have to be downloaded. There is currently no way I can keep track of this, as far as I know. So say it takes you 10 seconds to download a song, and the delay between songs is 5 seconds, the song will be cut off 5 seconds prematurely. I am looking into the possibility of caching songs (instead of only caching them temporarily, where they are deleted between startups of SpoutCraft).

EDIT:
By the way, if your server does not have the fastest upload speed, or you simply want to conserve the bandwidth, the textfile system is most likely a better choice. This way download speed will be reduced, the server will use less bandwidth, and it works like a charm .
Note that Spout can only download files with a http:// link and not https:// (Dropbox gives you a https:// link by default nowadays, remove the "s" in https:// to make it work.

 

Thanks dude!

 

Added instructions, as a lot of serverhosts were having trouble configuring .

 

Hello your plugin is very, very well but I have a question like the name of your texture pack that used as mod called SONIC'S UNBELIEVABLE ETHER shaders but as it is called the texture pack
(sorry for my English I'm from Spain and the basics of English)

 

Hey, glad you like it
The texture pack is 32x32 and it is called Eventime 1.0.3A (It is outdated, all those adventure-update textures are missing and appear invisible).

 

pls tell me how to open menu for change music... i try to use = above the 0 in my keyboard but doesnt's append..where i fail? how to open menuù of songs pls tell me...i just want to change song.. XD

 

Try pressing ALT (a few times) and then clicking =. If that doesn't work, you can change your personal setting in the controls part of the options of SpoutCraft

 

Hey
really nice plugin but... I have a problem!
I have added a ogg file to the Ambient folder... The file is 40 seconds long, so I have renamed it to "bla040"
I have reloaded the server and pressed "="... I have turned music on and there was a info which says "Downloading bla040" The file is 640kb big. I was waiting 20 minutes but I haven't heard a sound...
How can I fix it?

 

ok now it work ...but..at the moment i use my dedicated as web-server, and i have all my songs in ambient music, (i hope local area music will implement soon *.*)..however my question is in the string for the drop box...i see that you have put the option for coordinates...what it means? it means that at that coordinates music start?...

 

Try and see if your webserver is working in the first place, check the instructions, it states how you can test it .

levisn1
Those are for EffectLoops, you can see one of them in the video (the chimes sound).

 

this is string sufficent to work?
341 http://www.dropbox.com/s/suu65e4i54dctrc/BryanAdams.SummerOf69.ogg ? i dont want to spend bandwith in my dedicated so i choose dropbox way..but in this string i miss something?can you explane me bettere how it work?..volume world..ecc..only if it need..i want just ambient music, not loops..