Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rrwen/mixer-bot
Simplified chat bot for the mixer live streaming platform
https://github.com/rrwen/mixer-bot
bot chat live microsoft mixer ms platform simple stream streaming
Last synced: about 1 month ago
JSON representation
Simplified chat bot for the mixer live streaming platform
- Host: GitHub
- URL: https://github.com/rrwen/mixer-bot
- Owner: rrwen
- License: mit
- Created: 2020-03-13T18:41:37.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-03-16T20:28:39.000Z (almost 5 years ago)
- Last Synced: 2024-11-01T07:47:30.616Z (3 months ago)
- Topics: bot, chat, live, microsoft, mixer, ms, platform, simple, stream, streaming
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/mixer-bot
- Size: 1.19 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# mixer-bot
Richard Wen
[email protected]
* [Github](https://github.com/rrwen/mixer-bot)
* [Documentation](https://rrwen.github.io/mixer-bot)
Simplified chat bot for the mixer live streaming platform
[](https://badge.fury.io/js/mixer-bot)
[](https://travis-ci.org/rrwen/mixer-bot)
[](https://www.npmjs.com/package/mixer-bot)
[](https://github.com/rrwen/mixer-bot/blob/master/LICENSE)
[](https://donorbox.org/rrwen)
[](https://twitter.com/intent/tweet?text=Simplified%20chat%20for%20the%20mixer%20live%20streaming%20platform:%20https%3A%2F%2Fgithub.com%2Frrwen%2Fmixer-bot%20%23nodejs%20%23npm)
**Note**: This is based on a [Mixer chat bot tutorial](https://dev.mixer.com/guides/chat/chatbot) on the developer's page
## Install
1. Install [Node.js](https://nodejs.org/en/)
2. Install [mixer-bot](https://www.npmjs.com/package/mixer-bot) via `npm`
```
npm install -g mixer-bot
```
For the latest developer version, see [Developer Notes](DEVELOPER.md).
## Usage
The `mixerbot` package can be used as a command line tool or programatically in Node.js.
### In the Command Line
Create a `.env` file in the current directory if it does not exist:
* Replace `` with your access token
* A file `.env` will be created (**do not share this file**)
```
mixer-bot env
```
To run a mixer-bot:
* `` is the name of the mixer-bot npm package or .js file
```
mixer-bot run
```
If you want to create your own mixer-bot:
1. Create a bot template file `mixer-bot template`
2. Edit this file to change bot behaviour
3. Run the both with `mixer-bot run`
```
mixer-bot template ./template.js
mixer-bot run template.js
```
### In Node.js
An example usage of mixer-bot in `node`:
```javascript
const mixerbot = require('mixer-bot');
// Create a .env file in the same location and set
// MIXER_ACCESS_TOKEN=***
// MIXER_CHANNEL_ID=***
// Setup options
var options = {};
options.on = {};
options.greeting = 'Hello!';
// Setup channel ID
// If left unset, this will be the id to your channel
// Get your channel id here: https://mixer.com/api/v1/channels/?fields=id
// options.channel_id = '';
// Welcome a user when they join
options.on.UserJoin = data => {
socket = data.socket;
return response => {
socket.call('msg',[
`Hi ${response.username}! I'm pingbot! Write !ping and I will pong back!`,
]);
}
};
// Assign bot to pong user if they message !ping
options.on.ChatMessage = data => {
socket = data.socket;
return response => {
if (response.message.message[0].data.toLowerCase().startsWith('!ping')) {
socket.call('msg', [`@${response.user_name} PONG!`]);
console.log(`Ponged ${response.user_name}`);
}
}
};
// Handle errors
options.on.error = data => {
return error => {
console.error('Socket error');
console.error(error);
}
};
// Run mixer bot
mixerbot(options);
```
See [Documentation](https://rrwen.github.io/mixer-bot) for more details.
## Contributions
1. Reports for issues and suggestions can be made using the [issue submission](https://github.com/rrwen/mixer-bot/issues) interface.
2. Code contributions are submitted via [pull requests](https://github.com/rrwen/mixer-bot/pulls)
See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
## See Also
* [Developer Notes](DEVELOPER.md)