basicBot has been updated to work under plug's update. There may still be bugs and functionality is not guaranteed.
Make sure to update your bookmark, as the link has changed recently!!!
Important changes in version 2.x.x:
- Now should be fully compatible with Firefox.
- You can now change the bot's name, no need to make a fork to change it anymore. Available under custom settings as "botName".
- The bot's variable is now exposed outside of the script. You can access it as the variable "bot" in the console. This should allow for secondary scripts extending the bot without the need to fork and lose support on its basis. Be careful when extending it to make sure commands or features interact properly with the rest of them. An example script to extend the bot is provided under exampleExtension.js. Please do not fork this repository to just change that file. Details of how to use are provided inside. This is NOT needed to run the bot as it is provided, only if you want to add functionality.
- Command checking has been reworked to facilitate adding commands through secondary scripts as explained above.
Bookmark the following code. To run the bot, run the bookmark.
javascript:(function(){$.getScript('https://rawgit.com/Yemasthui/basicBot/master/basicBot.js');})();
If this does not work, go to https://raw.githubusercontent.com/Yemasthui/basicBot/master/basicBot.js and copy paste its content into your console (accessible in chrome by pressing f12) when on plug.dj in your community.
###Special settings###
For a more detailed explanation: see settingsGuide.md
Standard settings can be used. Both the default settings and an example of a custom settings file (uses the .json extension) are included. To use a settings file, make a public url for it. An easy way to do this is to upload it to dropbox and get a public link to it. Include the link (for example www.mysettings.com/settings.json ) like this in your room's description, followed by a space or an enter:
@basicBot=www.mysettings.com/settings.json
I would like to thank the following people:
- Fungus: His Tastybot has been a source of inspiration for most of the features, and his help with coding problems has been invaluable to make this bot.
- TAT, Origin and other Litebot contributors: Their Litebot has inspired features like Roulette.
- Henchman: Never knew this undertaking would give me a friend too.
Copyright © 2014 Mathieu Samaey
Modifications (including forks) of the code to fit personal needs are allowed only for personal use and should refer back to the original source. This software is not for profit, any extension, or unauthorised person providing this software is not authorised to be in a position of any monetary gain from this use of this software. Any and all money gained under the use of the software (which includes donations) must be passed on to the original author.
This bot is developed independently. Changes may be made without notice. There is no guarantee for the perfect functioning. Plug.dj admins have the right to request changes. By using this chatbot you agree to not use it for violating plug.dj's Terms of Service. You also agree not to alter the bot's code. Any requests for changes can be requested via email, through github or via plug.dj.
- data gets saved: upon refreshing the page the bot's data is saved up to 1 hour after refreshing
- dclookup: when a user leaves or disconnects, he/she can get his/her spot back when reconnecting within the specified time limit
- afk check: users that are afk (this is, not chatting: chats containing only a . or another symbol don't count), get automatically warned and removed after 2 warnings
- bouncer+: when enabled bouncers have extra permissions, like moving people in the waitlist
- mute: mute or unmute people
- cycleguard: disable DJ cycle waitlist if it's enabled too long
- lockguard: unlock the waitlist if it's locked for too long
- timeguard: skip songs that are too long
- MotD, Message of the Day: an optional message that is displayed every few songs
- links to facebook, youtube, a website... can be set using special bot settings
These can be found under the commands file.