Vapor plugin to manage friends list automatically.
- Accepts friend requests.
- Removes the oldest friend if the friends list becomes full.
- Sends welcome message.
- Provides custom events for other plugins to listen to.
- Admins are protected from being auto-removed
npm install vapor-friendslist
var friendslist = require('vapor-friendslist');
// Instantiate Vapor etc.
vapor.use(friendslist);
// or
vapor.use(friendslist, {
limit: 100,
welcomeMessage: 'Hello! Thanks for adding me.',
welcomeMessageDelay: 3000
});
Friends list limit. Default value: 100
Welcome message text. Default value: undefined
Welcome message delay in milliseconds. Default value: 3000
(3 seconds).
message
- A message string.
Standard Vapor message events to be used with logger.
Standard Vapor file events - readFile
/ writeFile
.
- steamID - user's SteamID64 as string
Friend request has been accepted.
- steamID - user's SteamID64 as string
Friend has been removed from friends list because the limit has been reached.
MIT. See LICENSE
.