Skip to content

Commit

Permalink
Updating documentation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
NanoDano committed Aug 23, 2020
1 parent 42ff243 commit 5016498
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 38 deletions.
10 changes: 5 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ Artificial intelligence (AI) chat bot for Discord written in Python
:caption: Overview

pages/getting-started
pages/chat-with-existing-bot
pages/invite-to-your-server
pages/chat-with-existing-bot
pages/setup-your-own-bot


Links
=====

* :ref:`search`
* Invite Cathy: https://cathy.devdungeon.com/invite/
* Home page: https://cathy.devdungeon.com/
* Source code: https://github.com/DevDungeon/ChattyCathy
* Home page: https://www.devdungeon.com/content/chatty-cathy
* AIML Tutorial: https://www.devdungeon.com/content/ai-chat-bot-python-aiml
* Live Demo: https://discord.gg/unSddKm
* Contact: nanodano@devdungeon.com
* Chat with Cathy on DevDungeon server: https://discord.gg/unSddKm
* Contact: cathy@devdungeon.com
32 changes: 19 additions & 13 deletions docs/pages/getting-started.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,22 @@
=====================
What is Cathy?
=====================
==============================
Get started with Cathy chatbot
==============================

Cathy is an artificial intelligence (AI) chat bot for Discord server.
It written in Python 3 and is easily extended with new commands.
You can invite the DevDungeon Cathy to your server or run your own version.
Cathy is an artificial intelligence (AI) chat bot for Discord servers.
Follow these instructions to start chatting with Cathy.

The chat bot intelligence is powered by AIML.
It comes packaged by default with the Alice bot set of XML files.
You can also add your own AIML files to modify the chat behavior in the
`cathy/aiml/custom/` folder. You can follow these tutorials to learn more about
using AIML with Python:
1) Invite
=========

- https://www.devdungeon.com/content/live-coding-discord-ai-chat-bots-python
- https://www.devdungeon.com/content/ai-chat-bot-python-aiml
First, invite Cathy to your server by visiting https://cathy.devdungeon.com/invite/
You must be an owner or admin to invite. Share the link with a server admin if you cannot invite yourself.

2) Create the #chat-with-cathy channel
======================================

You must create a channel named `#chat-with-cathy` if it does not exist.

3) Chat
=======

Chat in the `#chat-with-cathy` channel. Cathy will respond to anyone in this channel.
16 changes: 9 additions & 7 deletions docs/pages/invite-to-your-server.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,8 @@
Invite existing bot to your server
==================================

Chatty Cathy is a public bot that you can invite Chatty Cathy to your own
Discord server. If you invite the public bot, you will need to create a channel
named "chat-with-cathy" to chat with the bot. This is done to prevent the chat
spam in every channel. If you want to customize the channel name you can run
your own instance of the bot. Instructions are below. To invite the public bot,
just visit this authorization URL directly:
Cathy is a public bot that you can invite to your own Discord server.
Note that the bot only chats in a channel named `#chat-with-cathy`. Create the channel if it does not exist.

Invite the bot
==============
Expand All @@ -18,10 +14,16 @@ create a channel named ``#chat-with-cathy``.

Follow this link to invite the bot:

https://discordapp.com/oauth2/authorize?client_id=387435655925596160&scope=bot
https://cathy.devdungeon.com/invite/

Create the chat-with-cathy channel
==================================

Don't forget to create the ``#chat-with-cathy`` channel.
You must create this channel.
Talk in that channel.

Learn more
==========

Visit https://cathy.devdungeon.com/ to learn more.
20 changes: 20 additions & 0 deletions docs/pages/setup-your-own-bot.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,5 +80,25 @@ How can I create my own bot?
If you want to create your own bot, you can follow some of these tutorials on
DevDungeon.com


Learn more
==========

Learn how to make your own bots by following some of my tutorials:

- https://www.devdungeon.com/content/live-coding-discord-ai-chat-bots-python
- https://www.devdungeon.com/content/ai-chat-bot-python-aiml
- https://www.devdungeon.com/tags/aiml
- https://www.devdungeon.com/tags/discord



AIML files
==========

The chat bot intelligence is powered by AIML.

It comes packaged by default with the Alice bot set of XML files.

You can also add your own AIML files to modify the chat behavior in the
`cathy/aiml/custom/` folder.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

setup(
name='cathy',
version='4.0.0',
version='4.0.1',
description='Discord chat bot using AIML artificial intelligence.',
long_description="See https://github.com/DevDungeon/cathy",
url='https://github.com/DevDungeon/ChattyCathy',
Expand Down
12 changes: 0 additions & 12 deletions stats.rb

This file was deleted.

0 comments on commit 5016498

Please sign in to comment.