Skip to content
This repository has been archived by the owner on Nov 21, 2024. It is now read-only.

Latest commit

 

History

History

notifyme

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

Notify me plugin

This plugin will notify users when their names are mentioned and prefixed with a specific token

Usage

<script type="text/javascript" src="path_to_plugins/notifyme/candy.js"></script>
<link rel="stylesheet" type="text/css" href="path_to_plugins/notifyme/candy.css" />

...

CandyShop.NotifyMe.init();

Configuration options

nameIdentifier - String - The identifier to look for in a string. Defaults to '@'

playSound - Boolean - Whether to play a sound when the username is mentioned. Defaults to true

highlightInRoom - Boolean - Whether to highlight the username when it is mentioned. Defaults to true

normalizeNickname - Boolean - Whether to normalize the casing of the nickname to the way you entered it. Otherwise, leave the casing as the sender wrote it. Defaults to true

Example configurations

// Highlight my name when it's prefixed with a '+'
CandyShop.NotifyMe.init({
    nameIdentifier: '+',
    playSound: false
});

// Highlight and play a sound if my name is prefixed with a '-'
CandyShop.NotifyMe.init({
    nameIdentifier: '-'
});