Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joelpurra/botten-nappet
A Twitch bot and streaming tool.
https://github.com/joelpurra/botten-nappet
bot nodejs server streaming twitch twitch-api twitch-bot twitch-irc twitch-tv twitchbot
Last synced: 27 days ago
JSON representation
A Twitch bot and streaming tool.
- Host: GitHub
- URL: https://github.com/joelpurra/botten-nappet
- Owner: joelpurra
- License: agpl-3.0
- Created: 2018-01-18T15:52:11.000Z (almost 7 years ago)
- Default Branch: develop
- Last Pushed: 2018-07-29T15:25:21.000Z (over 6 years ago)
- Last Synced: 2024-04-11T21:09:11.175Z (7 months ago)
- Topics: bot, nodejs, server, streaming, twitch, twitch-api, twitch-bot, twitch-irc, twitch-tv, twitchbot
- Language: TypeScript
- Homepage: https://joelpurra.com/projects/botten-nappet/
- Size: 933 KB
- Stars: 5
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [botten-nappet](https://joelpurra.com/projects/botten-nappet/)
A Twitch bot and streaming tool.
## Usage
To be done.
## Configuration
The server code expects these environment variables to be set. See steps below for manual/developer steps to set/retrieve the values.
```shell
export TWITCH_APP_CLIENT_ID='configure me'
export TWITCH_APP_CLIENT_SECRET='configure me'
export TWITCH_APP_OAUTH_REDIRECT_URL='configure me'
export TWITCH_USER_NAME='configure me'
export VIDY_API_ROOT_URL='https://sandbox.vidy.cn/'
export VIDY_API_KEY_ID='sandbox'
export VIDY_API_KEY_SECRET='sandbox'
export VIDY_VIDEO_LINK_BASE_URL='https://vidy.cn/v/'
export VIDY_SYSTEM_UUID='configure me'
export BOTTEN_NAPPET_SHARED_LOG_FILE="${TMPDIR}.botten-nappet.log"
export BOTTEN_NAPPET_BACKEND_DATABASE_URI="nedb://.../path/to/botten-nappet/database-directory"
```
## Installation
```shell
npm install
npm run --silent build
```
## Running the server
```shell
npm run --silent start
```
## Development
Follow [git-flow](https://danielkummer.github.io/git-flow-cheatsheet/) and use [git-flow-avh](https://github.com/petervanderdoes/gitflow-avh).
```shell
# Make sure git-flow is initialized.
git flow init -d
# Clean, test, build, watch javascript code for changes.
npm run --silent clean
npm run --silent build
npm run --silent test
npm run --silent watch
# Modify the ZeroMQ port if running multiple instances.
#export BOTTEN_NAPPET_SHARED_ZMQ_ADDRESS="tcp://localhost:61611"
# Set logging parameters.
export BOTTEN_NAPPET_SHARED_LOGGING_LEVEL='trace'
export BOTTEN_NAPPET_SHARED_LOG_FILE="${TMPDIR}.botten-nappet.log"
# Start debugger. Connect to it using Google Chrome, see chrome://inspect/
# https://medium.com/@paul_irish/debugging-node-js-nightlies-with-chrome-devtools-7c4a1b95ae27
# Run "debug" for normal debugging, or "debug:break" to break on the first statement.
# NOTE: pipes log output to a file, which is pretty-printed separately.
npm run --silent debug
# New terminal window: watch log file and pretty print.
tail -f "$BOTTEN_NAPPET_SHARED_LOG_FILE" | ./node_modules/.bin/pino
```
## Developer environment setup
The below steps assume a `bash` shell.
### Prepare variables
```shell
# Create a Twitch application, get your client id/secret from there.
open 'https://dev.twitch.tv/dashboard/apps/create'
# Your application details.
export TWITCH_APP_CLIENT_ID='your twitch client id here'
export TWITCH_APP_CLIENT_SECRET='your twitch client secret here'
# Set OAuth landing page for authorized users.
# NOTE: use the same address here as in the applcation registration.
# NOTE: this should be one of your own domains/websites.
# TODO: build a page which accepts the authorized user's code automatically.
export TWITCH_APP_OAUTH_REDIRECT_URL='https://example.com/'
# Set username to gain access to.
export TWITCH_USER_NAME='your-twitch-username'
```
### Shutting down the development environment
Best practice includes revoking the above temporary development tokens.
```shell
# Revoke user access token.
# TODO: curl local development revoke url.
```
```shell
# Unset all of the exported variables.
# NOTE: there might be more custom settings.
export -n TWITCH_APP_CLIENT_ID
export -n TWITCH_APP_CLIENT_SECRET
export -n TWITCH_APP_OAUTH_REDIRECT_URL
export -n TWITCH_USER_NAME
export -n VIDY_API_ROOT_URL
export -n VIDY_VIDEO_LINK_BASE_URL
export -n VIDY_API_KEY_ID
export -n VIDY_API_KEY_SECRET
export -n VIDY_SYSTEM_UUID
export -n BOTTEN_NAPPET_SHARED_LOG_FILE
export -n BOTTEN_NAPPET_BACKEND_DATABASE_URI
```
### Generating dependency graphs
Some dependencies are easier to analyze with some visual aid, in the form of graphs in `.pdf` format.
- Requires [graphviz](https://www.graphviz.org).
- It's easy to modify the generated `.gv` files to fix layout issues as well as remove/comment out parts of the graph — it can get pretty cluttered.
- Some parts of the runtime generation can be configured to include/exclude/cluster classes.
**Build time module import graphs**
```shell
# NOTE: generates graphs for the rollup config files.
# NOTE: see output in rollup.config.*.gv.
# NOTE: see output in rollup.config.*.gv.pdf.
npm run --silent graph
```
**Runtime dependency injection graph**
```shell
# NOTE: enable dependency injection graph generation.
# NOTE: see configuration files.
export BOTTEN_NAPPET_GENERATE_GRAPH="true"
# NOTE: start the server.
npm run --silent start
# NOTE: the graph is written to disk after server shutdown.
# NOTE: these commands generates most recent graph to pdf.
# NOTE: see output in dependency-graph.*.gv.
# NOTE: see output in dependency-graph.*.gv.pdf.
export DGGV="$(find . -iname 'dependency-graph.*.gv' | sort | tail -n 1)"
dot -T "pdf" -O "$DGGV"
echo "$DGGV"
open "${DGGV}.pdf"
```
## Acknowledgements
- thor10768765 on Twitch for inspiration and pushing me to start this project.
---
[botten-nappet](https://joelpurra.com/projects/botten-nappet/) Copyright © 2018 [Joel Purra](https://joelpurra.com/). Released under [GNU Affero General Public License version 3.0 (AGPL-3.0)](https://www.gnu.org/licenses/agpl.html). [Your donations are appreciated!](https://joelpurra.com/donate/)