diff options
| author | jason | 2017-07-10 10:11:52 -0600 |
|---|---|---|
| committer | jason | 2017-07-10 10:11:52 -0600 |
| commit | 3be3552a9afc7ad05f6470690f5da737499a02ba (patch) | |
| tree | 7b06e0fdf68c4515ea93fd06e0cc7d665b7e639f | |
| parent | 583c4f179bd37d368f0213ddb5a372ca688952b6 (diff) | |
| download | warmachine-ng-3be3552a9afc7ad05f6470690f5da737499a02ba.tar.gz warmachine-ng-3be3552a9afc7ad05f6470690f5da737499a02ba.zip | |
| -rw-r--r-- | README.org | 8 |
1 files changed, 4 insertions, 4 deletions
| @@ -1,7 +1,7 @@ | |||
| 1 | # LocalWords: asyncio async plugin | 1 | # LocalWords: asyncio async plugin |
| 2 | 2 | ||
| 3 | * Setting up the bot | 3 | * Setting up the bot |
| 4 | D'bolla is a no bullshit extensible IRC/Slack bot written for Python 3.5 using | 4 | Warmachine is a no bullshit extensible IRC/Slack bot written for Python 3.5 using |
| 5 | asyncio. | 5 | asyncio. |
| 6 | 6 | ||
| 7 | ** Install dependencies: | 7 | ** Install dependencies: |
| @@ -11,7 +11,7 @@ asyncio. | |||
| 11 | #+END_SRC | 11 | #+END_SRC |
| 12 | 12 | ||
| 13 | ** Configure | 13 | ** Configure |
| 14 | Copy dbolla.conf.example to dbolla.conf and edit this file. You can | 14 | Copy warmachine.conf.example to warmachine.conf and edit this file. You can |
| 15 | specify multiples of the same connection by prefixing the config section with | 15 | specify multiples of the same connection by prefixing the config section with |
| 16 | 'slack:' or 'irc:' followed by a unique name for this connection. | 16 | 'slack:' or 'irc:' followed by a unique name for this connection. |
| 17 | 17 | ||
| @@ -19,7 +19,7 @@ specify multiples of the same connection by prefixing the config section with | |||
| 19 | Simply run the command: | 19 | Simply run the command: |
| 20 | 20 | ||
| 21 | #+BEGIN_SRC bash | 21 | #+BEGIN_SRC bash |
| 22 | ./bin/dbolla -c /path/to/my/dbolla.conf | 22 | ./bin/warmachine -c /path/to/my/warmachine.conf |
| 23 | #+END_SRC | 23 | #+END_SRC |
| 24 | 24 | ||
| 25 | * Writing a Plugin | 25 | * Writing a Plugin |
| @@ -87,7 +87,7 @@ defined somewhere near the top of your file. | |||
| 87 | ** ~self.config_dir~ | 87 | ** ~self.config_dir~ |
| 88 | The directory to store any configuration files and other junk in. | 88 | The directory to store any configuration files and other junk in. |
| 89 | ** ~self.connect()~ | 89 | ** ~self.connect()~ |
| 90 | D'bolla uses python 3's asyncio to manage multiple connections concurrently thus | 90 | Warmachine uses python 3's asyncio to manage multiple connections concurrently thus |
| 91 | you should use ~asyncio.open_connection~ to create your connection. Once you | 91 | you should use ~asyncio.open_connection~ to create your connection. Once you |
| 92 | have successfully connected you must set ~self.status~ to | 92 | have successfully connected you must set ~self.status~ to |
| 93 | ~warmachine.connections.base.CONNECTED~. This indicates the connection is ready | 93 | ~warmachine.connections.base.CONNECTED~. This indicates the connection is ready |