Writer Bot

Writer-Bot is a discord bot for writing-based servers.
It has many features, such as writing sprints, word count goals, xp/levels, prompts and random generators
Report Bug · Request Feature

Table of Contents

• About the Project
• Bot Usage
• Roadmap
• Development
• Contributing
• License
• Credits

About The Project

Writer Bot began life as a small project for one writing server on discord of which I was a member. We were using a sprint bot, but I thought it would be quite handy to have more functionality, so decided to make my own bot for the server to use. This original version of the bot was written in node.js, using the discord.js library.

After releasing it to that server, as an after-thought I decided to add it to one of the discord bot lists, in case anyone else found it useful.

The bot soon became quite popular, being added to hundreds, then thousands of servers, and it became quite apparent that the way I had made it, just wasn't suited to lots of servers and there were lots of problems. So I decided to re-write the entire thing in Python instead and try to make it function better across multiple servers.

At the time of writing this, the bot is now in over 7000 servers and (for the most part) is going strong.

Bot Usage

Writing-related commands

!ask: Asks you a random question about your character or your world, to get the creative juices flowing.

!challenge: Generates a random writing challenge for you. e.g. "Write 400 words in 15 minutes". You can add the flags "easy", "normal", "hard", "hardcore", or "insane" to choose a pre-set wpm, or add your chosen wpm as the flag, or you can specify a time instead by adding a the time in minutes, prefixed with a "t", e.g. "t15"

!event: Create server-wide writing events and compete against your fellow writers to see who can write the most

!generate: Random generator for various things (character names, place names, land names, book titles, story ideas). Define the type of item you wanted generated and then optionally, the amount of items to generate.

!goal: Sets a daily goal which resets every 24 hours

!project: Using these commands, you can create different projects and store word counts against them seperately. They also integrate with the wrote and sprint commands. See the help information for those commands for more info.

!sprint: Write with your friends and see who can write the most in the time limit!

!wrote: Add to your total words written statistic

Fun commands

!8ball: Ask the magic 8-ball a question. Your question will be routed to a text-processing AI and broken down into character sets, in order to properly analyze the content of the question and provide a meaningful answer.

!flip: Flips a coin

!quote: Gives you random motivational quote

!reassure: Gives you reassurance/motivation

!roll: Rolls a dice between 1-6, or 1 and a specified number

!xp: Checks your server Experience Points and Level. Use the "top" flag to see the top 10 on this server.

Utility Commands

!about: Shows bot information and status

!help: Display help information about the bot and its commands

!invite: Generates an invite link to invite the bot to another server

!mysetting: Allows you to set user configuration values, such as your timezone

!ping: Ping the bot to check the latency

!profile: Displays your user statistics

!reset: Allows you to reset your stats

!setting: Allows users with the (MANAGE_MESSAGES) permission on the server, to change configuration values

Roadmap

See the open issues for a list of proposed features (and known issues).

Development

To get a local copy of Writer Bot up and running, please see the separate Writer Bot Development Environment repo.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Development Environment project
2. Create your Feature Branch in the app submodule (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the GNU General Public (V3) License. See LICENSE.txt for more information.

Credits

Thank you to everyone who gets involved in helping out with Writer Bot, whether that is writing code, translating language strings, answering questions on the support server, or even just using the bot! Without you, Writer Bot would just be some code sitting on a server doing nothing.

Code Contributors

https://github.com/cwarwicker/discord-Writer-Bot/graphs/contributors

Translators

kdem - French Translations