Winnie_Bot

Winnie is a Discord bot for authors. Winnie allows users to track goals, challenge each other to word wars and sprints, and get prompts to assist with their writing.

---

Table of Contents

• Adding Winnie to your Discord server
  • Inviting the public Winnie_Bot account
  • Setting up your own instance of Winnie
  • Requirements
  • Setting up a Discord bot instance
  • Inviting your instance of Winnie to your server
• Using Winnie
  • Basic Features
  • Commands
• Dependencies and frameworks
• Privacy Policy and Data Deletion
• Contributing to Winnie
• Core Team
• License
• Acknowledgments

Adding Winnie to your Discord server

If you want to run Winnie on your server, you can either invite the public Winnie_Bot account or set up your own Discord bot with Winnie's code.

Inviting the public Winnie_Bot account

If you want to invite the public Winnie_Bot account to your server, go here.

Setting up your own instance of Winnie

Requirements

• Node.js
• Yarn Package Manager
• Docker/Docker Compose

Setting up a Discord bot instance

• Sign in to Discord
• Go to the Discord Dev Portal, and click on 'My Apps'
• Click on 'New App' to create a Discord application
• Go to the Bot tab, and click the Add Bot button to create a bot user
• Copy the token under Bot/Token - you will need this in the next step

Installation Instructions

You can use the start-winnie.sh script to install Winnie's components as services on Linux machines.

Inviting your instance of Winnie to your server

Click the 'Generate OAuth2 URL' button in the Discord Developer pane to generate your invite URL. Using the invite URL, you can invite your instance of Winnie to any Discord server on which you have administrator permissions.

Using Winnie

Basic features

Winnie currently consists of the following features:

• Goals: Set targeted writing goals for yourself each day, week, month, or year
• Challenges: Set timers for yourself, and write as much as you can with other people in your server
• Writing prompts: Get prompts for character building, worldbuilding, and a variety of genre-specific situations

The following new features are currently on the core team's roadmap:

• Encouragement and self-care prompts
• Projects: Set targeted writing goals for individual projects over whatever period of time you want
• Events: Create and participate in scheduled events within your own server, or global events that are open to all servers using Winnie

Commands

You can find more information about Winnie's commands in the documentation.

Dependencies and frameworks

• BullMQ - Event Queue Management
• Class-Validator - Model validations
• Discord.js - Discord API for Node.js
• ESLint - Linting
• i18next - Internationalization
• Luxon - Date/Time manipulation
• node-cron - Job scheduling
• PostgreSQL - Persistent storage
• TypeORM - Database Interaction
• Winston - Log management

Privacy Policy and Data Deletion

Please see our Privacy Policy here.

Contributing to Winnie

We welcome all contributions to Winnie. Please see the contributing guidelines for more information on how to get involved.

Additionally, we expect all contributors to follow the Code of Conduct.

Core Team

Dawn E. Collett	Jason E. Gillikin	Katie Macke

License

This project is licensed under the GNU General Public License, v3.0 - see the LICENSE file for details. In particular, if you incorporate Winnie's source code into another project, you must release the source code of that project.

Acknowledgments

• Winnie is inspired by Timmy, ChatNaNo's IRC bot. Timmy can be found at utoxin/TimTheWordWarBot.
• Prompts were brainstormed by NaNo's Australia::Melbourne region.
• Winnie's avatar, 'Tiny Cities', was created by Rachael Wheeler. Prints, notebooks, and other items featuring 'Tiny Cities' are available for purchase here.