Room SettingsA guide on customizing your community

Setup



To use room settings with plug³, you'll need a JSON file hosted on a server. Then add to your community description as shown below. Note that it must be an https URL, have the correct headers, and be valid JSON

@p3=https://example.com/rs.json


Plug³ offers room hosting at the following URL: plug³ Room Settings Host
To set the headers for your web server please see the following examples

Nginx:


                                    
                                        add_header   Access-Control-Allow-Origin 'https://plug.dj';
                                        //or
                                        add_header   Access-Control-Allow-Origin '*';
                                    
                                

Apache:


                                    
                                        Header set Access-Control-Allow-Origin "https://plug.dj"
                                        //or
                                        Header set Access-Control-Allow-Origin "*"
                                
                                

Room Settings Rules


Author

The author of the room settings By default it is set to an empty string

                                                        
                                                            {
                                                                "author": "TheDark1337"
                                                            }
                                                        
                                                    

Colors


colors.background

Changes the background color of the room. By default it is set to an empty string

                                                        
                                                            {
                                                                "colors": {
                                                                    "background": "FF0000"
                                                                }
                                                            }
                                                        
                                                    

colors.footer

Changes the footer color of the room. By default it is set to an empty string

                                                        
                                                            {
                                                                "colors": {
                                                                    "footer": "FF0000"
                                                                }
                                                            }
                                                        
                                                    

colors.header

Changes the header color of the room. By default it is set to an empty string

                                                        
                                                            {
                                                                "colors": {
                                                                    "header": "FF0000"
                                                                }
                                                            }
                                                        
                                                    

colors.chat.*

Changes the colors of the ranks. By default it is set to an empty object

                                                        
                                                            {
                                                                "colors": {
                                                                    "chat": {
                                                                        "admin": "FF0000",
                                                                        "ambassador": "FFFF00",
                                                                        "host": "0000FF",
                                                                        "cohost": "00FF00",
                                                                        "manager": "000000",
                                                                        "bouncer": "FFFFFF",
                                                                        "residentdj": "00FFFF"
                                                                    }
                                                                }
                                                            }
                                                        
                                                    

CSS


css.font

List of fonts that needs to be imported. By default it is set to an empty array

                                                        
                                                            {
                                                                "css": {
                                                                    "font": [{
                                                                        "name": "Font 1 Name",
                                                                        "url": "Url to font"
                                                                    }, {
                                                                        "name": "Font 2 Name",
                                                                        "url": {
                                                                            "ttf": "Url 1 to font",
                                                                            "woff": "Url 2 to font"
                                                                        }
                                                                    }]
                                                                }
                                                            }
                                                        
                                                    

css.import

List of CSS files that needs to be imported. By default it is set to an empty array

                                                        
                                                            {
                                                                "css": {
                                                                    "import":[
                                                                        "https:\/\/example.com\/example1.css",
                                                                        "https:\/\/example.com\/example2.css"
                                                                    ]
                                                                }
                                                            }
                                                        
                                                    

css.rule

List of CSS Rules that will be set. By default it is set to an empty object

                                                        
                                                            {
                                                                "css": {
                                                                    "rule": {
                                                                        "#room-name": {
                                                                            "color": "blue",
                                                                            "font-variant": "small-caps"
                                                                        },
                                                                        "#now-playing-media": {
                                                                            "font-variant": "small-caps"
                                                                        }
                                                                    }
                                                                }
                                                            }
                                                        
                                                    

Images


images.background

Changes the background image of the room. By default it is set to an empty string

                                                        
                                                            {
                                                                "images": {
                                                                    "background": "https:\/\/example.com\/background.png"
                                                                }
                                                            }
                                                        
                                                    

images.booth

Sets the booth image (Max 300px x 100px). By default it is set to an empty string

                                                        
                                                            {
                                                                "images": {
                                                                    "booth": "https:\/\/example.com\/booth.png"
                                                                }
                                                            }
                                                        
                                                    

images.icons.*

Changes the icon of a rank. By default it is set to an empty object

                                                        
                                                            {
                                                                "images": {
                                                                    "icons": {
                                                                        "admin": "https:\/\/example.com\/admin.png",
                                                                        "ambassador": "https:\/\/example.com\/ambassador.png",
                                                                        "host": "https:\/\/example.com\/host.png",
                                                                        "cohost": "https:\/\/example.com\/cohost.png",
                                                                        "manager": "https:\/\/example.com\/manager.png",
                                                                        "bouncer": "https:\/\/example.com\/bouncer.png",
                                                                        "residentdj": "https:\/\/example.com\/residentdj.png"
                                                                    }
                                                                }
                                                            }
                                                        
                                                    

Rules


rules.allowAutojoin

Allow plug³ users to use autojoin. By default it is set to true

                                                        
                                                            {
                                                                "rules": {
                                                                    "allowAutojoin": true
                                                                }
                                                            }
                                                        
                                                    

rules.allowAutorespond

Allow plug³ users to use AFK Autorespond . By default it is set to true

                                                        
                                                            {
                                                                "rules": {
                                                                    "allowAutorespond": true
                                                                }
                                                            }
                                                        
                                                    

rules.allowAutowoot

Allow plug³ users to use autowoot. By default it is set to true

                                                        
                                                            {
                                                                "rules": {
                                                                    "allowAutowoot": true
                                                                }
                                                            }
                                                        
                                                    

rules.allowEmotes

Allow plug³ users to use emotes (BetterTTV, FrankerFFZ, Tasty, Twitch, Twitch Subscriber). By default it is set to true

                                                        
                                                            {
                                                                "rules": {
                                                                    "allowEmotes": true
                                                                }
                                                            }
                                                        
                                                    

rules.allowShowingMehs

Allow plug³ users to see who mehs (Note: Bouncers & above ignores this rule). By default it is set to true

                                                        
                                                            {
                                                                "rules": {
                                                                    "allowShowingMehs": true
                                                                }
                                                            }
                                                        
                                                    

Example Room Settings


Below is a template file to get started with

                                    
                                        {
                                            "author": "",
                                            "colors": {
                                            "background": "",
                                            "chat": {
                                                "admin": "",
                                                "ambassador": "",
                                                "host": "",
                                                "cohost": "",
                                                "manager": "",
                                                "bouncer": "",
                                                "residentdj": ""
                                            },
                                                "footer": "",
                                                "header": ""
                                            },
                                            "css": {
                                                "font": [],
                                                "import": [],
                                                "rule": {}
                                            },
                                            "images": {
                                                "background": "",
                                                "booth": "",
                                                "icons": {
                                                    "admin": "",
                                                    "ambassador": "",
                                                    "host": "",
                                                    "cohost": "",
                                                    "manager": "",
                                                    "bouncer": "",
                                                    "residentdj": ""
                                                },
                                                "playback": ""
                                            },
                                            "rules": {
                                                "allowAutojoin": "true",
                                                "allowAutorespond": "true",
                                                "allowAutowoot": "true",
                                                "allowEmotes": "true",
                                                "allowShowingMehs": "true"
                                            }
                                    }
                                    
                                

Start Using plug³

Either install the userscript by clicking it below or install a browser extension, or click and drag one of the buttons to your bookmarks, and whilst using plug.dj, run the bookmark!





Browser Extensions

Automatically Run plug³

 




Manually add to your bookmarks

Just copy the code below and create a new bookmark:

javascript:(function(){$.getScript('https://plugcubed.net/scripts/release/plugCubed.js');}());