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

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Fully rewritten
    AmbientSpout



    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:



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



    AmbientSpout
    Free Version | BukkitDev

    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:


    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 post has been edited 21 times. It was last edited by Rahazan Jul 6, 2012.
  2.  
  3. Offline

    Rahazan

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    @Astaen
    @Ghare
    @ricflair71

    Hey everybody,

    I would like to inform all of you that I am no longer active as a developer for anything Minecraft related, so don't expect an update coming from my behalf. Currently university takes too much of my time to be actively developing anything in my spare time..
    At university I was taught how to properly program in a neat, documented way. Whenever I look at the source of this plugin it scares me a little, as I was a Java-newbie at the time. That's the reason the source is not available at this moment, also, it is not on the laptop I am currently working on. It's on my desktop computer at University, if you really, really want this source, send me a PM and I will send it to you when I am able to do so.

    Yours truly,
    Rahazan
  4. Offline

    kagecookeh

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Please Update D:<

    *edit* i just loaded the message above D:*

    This post has been edited 1 time. It was last edited by kagecookeh Jun 28, 2012.
  5. Offline

    Alvarez96

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
  6. Offline

    kagecookeh

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    i got a friend to update the plugin, but how do i add music to the plugin?
  7. Offline

    tsuna25

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    ...........
  8. Offline

    kagecookeh

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    lol our update failed we are currently fixing, forget i asked on the add music part >.<
  9. Offline

    Rahazan

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Update sometime soon, total rewrite.


    This post has been edited 1 time. It was last edited by Rahazan Jul 1, 2012.
  10. Offline

    Rahazan

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    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 :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


    This post has been edited 4 times. It was last edited by Rahazan Jul 1, 2012.
  11. Offline

    Rahazan

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)

    This post has been edited 1 time. It was last edited by Rahazan Jul 3, 2012.
  12. Offline

    kagecookeh

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Amazing! Omg this great! i cant wait till you get the music on area implimented :D also do you mind if i make a video for this? like how to config and setup?
  13. Offline

    Rahazan

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    I'd love to see you make one :) Do note that configuration and setup MAY still change, ehh :)
  14. Offline

    kagecookeh

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
  15. Offline

    Duning

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Lol, Current song:Bowerstone, I'm a fable fanboy :)
    Rahazan likes this.
  16. Offline

    tsuna25

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    I want a video before I try it. ;)
  17. Offline

    Rahazan

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Note that you have to enter your server IP @ HostAddress if you want to use the webserver :).
  18. Offline

    Rahazan

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Added a video demonstration
    tsuna25 likes this.
  19. Offline

    TheMinecraftVoid

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    I am now testing it :) Thanks again for replying to my post!
  20. Offline

    Rahazan

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Which server? I'll hop on for a few minutes ;).

    This post has been edited 1 time. It was last edited by Rahazan Jul 4, 2012.
  21. Offline

    TheMinecraftVoid

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    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?

    This post has been edited 1 time. It was last edited by TheMinecraftVoid Jul 4, 2012.
  22. Offline

    tsuna25

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    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.
  23. Offline

    Rahazan

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    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 :/..

    This post has been edited 4 times. It was last edited by Rahazan Jul 4, 2012.
  24. Offline

    Rahazan

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Hard to hop on when I'm not whitelisted, heh. My IGN is Rahazan, like here on the forums.
  25. Offline

    TheMinecraftVoid

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Alright. You should be whitelisted.
  26. Offline

    TheMinecraftVoid

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Haven't tested the sound effects but works like a charm! Definitely one of the best plugins out there.
  27. Offline

    thomas Freeborough

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    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?
  28. Offline

    Rahazan

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    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.

    This post has been edited 2 times. It was last edited by Rahazan Jul 4, 2012.
  29. Offline

    CooperTheCreeper

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Thanks dude!
    :)
    Rahazan likes this.
  30. Offline

    Rahazan

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Added instructions, as a lot of serverhosts were having trouble configuring ;).
  31. Offline

    valenmew3333

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    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)
  32. Offline

    Rahazan

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    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).

Share This Page