Skip to content

i-hardy/woolf

Repository files navigation

Woolf

CircleCI join the tech support server invite the bot to your server

Five hundred a year and a bot of one's own...

A Discord bot for writers.

Features

  • Custom-length timers for writing sprints
  • Fetches various word relations using the DataMuse API
  • Fetches inspirational photos using the Flickr API

Usage

Click on the link at the top of the README to invite the bot to your server. Be aware that the writing sprint functionality will not work unless the bot has permission to manage roles on your server. Please see Discord's Role Management 101.

To host the bot yourself, clone the repository, install nvm, and create a .env file using the .env.sample file as a guide. Then run:

nvm install
npm install
npm start

You can also use the provided Dockerfile, or pull the latest prebuilt image from imogenhardy/woolf:latest. The bot is set up to output logs to Loggly, but will default to stdout if no Loggly client token is set.

Woolf 1.0

This bot was originally written in Ruby, and rewritten in Typescript in Autumn 2020. To use the legacy Ruby version, switch to the branch 1.0.

About

A Discord bot for writers

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages