mirror of
https://github.com/pragma-/pbot.git
synced 2024-11-25 13:29:29 +01:00
doc/Commands.md: progress
This commit is contained in:
parent
d2aca1a296
commit
261072e3e9
148
doc/Commands.md
148
doc/Commands.md
@ -18,20 +18,65 @@
|
|||||||
* [Command documentation](#command-documentation)
|
* [Command documentation](#command-documentation)
|
||||||
* [Administrative commands](#administrative-commands)
|
* [Administrative commands](#administrative-commands)
|
||||||
* [Logging in and out of PBot](#logging-in-and-out-of-pbot)
|
* [Logging in and out of PBot](#logging-in-and-out-of-pbot)
|
||||||
|
* [login](#login)
|
||||||
|
* [logout](#logout)
|
||||||
* [Admin management commands](#admin-management-commands)
|
* [Admin management commands](#admin-management-commands)
|
||||||
|
* [adminadd](#adminadd)
|
||||||
|
* [adminrem](#adminrem)
|
||||||
|
* [adminset](#adminset)
|
||||||
|
* [adminunset](#adminunset)
|
||||||
|
* [list admins](#list-admins)
|
||||||
* [Channel management commands](#channel-management-commands)
|
* [Channel management commands](#channel-management-commands)
|
||||||
|
* [join](#join)
|
||||||
|
* [part](#part)
|
||||||
|
* [chanadd](#chanadd)
|
||||||
|
* [chanrem](#chanrem)
|
||||||
|
* [chanset](#chanset)
|
||||||
|
* [chanunset](#chanunset)
|
||||||
|
* [chanlist](#chanlist)
|
||||||
* [Module management commands](#module-management-commands)
|
* [Module management commands](#module-management-commands)
|
||||||
|
* [load](#load)
|
||||||
|
* [unload](#unload)
|
||||||
|
* [list modules](#list-modules)
|
||||||
* [Plugin management commands](#plugin-management-commands)
|
* [Plugin management commands](#plugin-management-commands)
|
||||||
|
* [plug](#plug)
|
||||||
|
* [unplug](#unplug)
|
||||||
|
* [pluglist](#pluglist)
|
||||||
|
* [Command metadata commands](#command-metadata-commands)
|
||||||
|
* [cmdset](#cmdset)
|
||||||
|
* [cmdunset](#cmdunset)
|
||||||
* [Registry commands](#registry-commands)
|
* [Registry commands](#registry-commands)
|
||||||
|
* [regset](#regset)
|
||||||
|
* [regunset](#regunset)
|
||||||
|
* [regchange](#regchange)
|
||||||
|
* [regshow](#regshow)
|
||||||
|
* [regfind](#regfind)
|
||||||
|
* [regsetmeta](#regsetmeta)
|
||||||
|
* [regunsetmeta](#regunsetmeta)
|
||||||
* [Miscellaneous admin commands](#miscellaneous-admin-commands)
|
* [Miscellaneous admin commands](#miscellaneous-admin-commands)
|
||||||
|
* [export](#export)
|
||||||
|
* [refresh](#refresh)
|
||||||
|
* [reload](#reload)
|
||||||
|
* [sl](#sl)
|
||||||
|
* [die](#die)
|
||||||
* [Factoid commands](#factoid-commands)
|
* [Factoid commands](#factoid-commands)
|
||||||
* [Adding factoids](#adding-factoids)
|
* [[fact](Factoids.md#fact)](#factfactoidsmdfact)
|
||||||
* [Viewing factoids](#viewing-factoids)
|
* [factadd](#factadd)
|
||||||
* [Deleting factoids](#deleting-factoids)
|
* [factrem](#factrem)
|
||||||
* [Aliasing commands](#aliasing-commands)
|
* [factshow](#factshow)
|
||||||
* [Moving/renaming factoids](#movingrenaming-factoids)
|
* [factchange](#factchange)
|
||||||
* [Editing factoids](#editing-factoids)
|
* [factalias](#factalias)
|
||||||
* [Information about a factoid](#information-about-a-factoid)
|
* [factmove](#factmove)
|
||||||
|
* [factundo](#factundo)
|
||||||
|
* [factredo](#factredo)
|
||||||
|
* [factlog](#factlog)
|
||||||
|
* [factset](#factset)
|
||||||
|
* [factunset](#factunset)
|
||||||
|
* [factfind](#factfind)
|
||||||
|
* [factinfo](#factinfo)
|
||||||
|
* [count](#count)
|
||||||
|
* [histogram](#histogram)
|
||||||
|
* [top20](#top20)
|
||||||
* [Miscellaneous commands](#miscellaneous-commands)
|
* [Miscellaneous commands](#miscellaneous-commands)
|
||||||
<!-- md-toc-end -->
|
<!-- md-toc-end -->
|
||||||
|
|
||||||
@ -117,7 +162,7 @@ subroutine and data structures.
|
|||||||
Built-in commands are created via the `register()` function of the `Commands`
|
Built-in commands are created via the `register()` function of the `Commands`
|
||||||
module. Such commands are registered throughout PBot's source code. The owner
|
module. Such commands are registered throughout PBot's source code. The owner
|
||||||
of the PBot instance can locally add new commands by editing PBot's source code
|
of the PBot instance can locally add new commands by editing PBot's source code
|
||||||
or by acquiring and loading new Plugins.
|
or by acquiring and loading Plugins.
|
||||||
|
|
||||||
#### Plugins
|
#### Plugins
|
||||||
|
|
||||||
@ -128,18 +173,17 @@ Plugins have access to PBot's internal APIs and data structures.
|
|||||||
### Factoids
|
### Factoids
|
||||||
|
|
||||||
Factoids are another type of command. Factoids are simple textual strings that
|
Factoids are another type of command. Factoids are simple textual strings that
|
||||||
anybody can create. At their most simple, they simply display their text when
|
anybody can create. At their most simple, they display their text when invoked.
|
||||||
invoked. However, significantly more complex Factoids can be created by using
|
However, significantly more complex Factoids can be created by using the powerful
|
||||||
the powerful interpreter and by using the even more powerful `/code` Factoid
|
interpreter and by using the even more powerful `/code` Factoid command.
|
||||||
command.
|
|
||||||
|
|
||||||
Factoids do not have access to PBot's internal API or data structures.
|
Factoids do not have access to PBot's internal API or data structures.
|
||||||
|
|
||||||
#### Code Factoids
|
#### Code Factoids
|
||||||
|
|
||||||
Code Factoids are simple Factoids that are created using the `/code` command.
|
Code Factoids are Factoids whose text begins with the `/code` command.
|
||||||
These Factoids will execute their textual string using the scripting or programming
|
These Factoids will execute their text using the scripting or programming
|
||||||
language invoked by the `/code` command.
|
language specified by the `/code` command.
|
||||||
|
|
||||||
Code Factoids do not have access to PBot's internal API or data structures.
|
Code Factoids do not have access to PBot's internal API or data structures.
|
||||||
|
|
||||||
@ -159,33 +203,81 @@ Here is the documentation for all of PBot's commands.
|
|||||||
|
|
||||||
#### Logging in and out of PBot
|
#### Logging in and out of PBot
|
||||||
|
|
||||||
|
##### login
|
||||||
|
##### logout
|
||||||
|
|
||||||
#### Admin management commands
|
#### Admin management commands
|
||||||
|
|
||||||
|
##### adminadd
|
||||||
|
##### adminrem
|
||||||
|
##### adminset
|
||||||
|
##### adminunset
|
||||||
|
##### list admins
|
||||||
|
|
||||||
#### Channel management commands
|
#### Channel management commands
|
||||||
|
|
||||||
|
##### join
|
||||||
|
##### part
|
||||||
|
##### chanadd
|
||||||
|
##### chanrem
|
||||||
|
##### chanset
|
||||||
|
##### chanunset
|
||||||
|
##### chanlist
|
||||||
|
|
||||||
#### Module management commands
|
#### Module management commands
|
||||||
|
|
||||||
|
##### load
|
||||||
|
##### unload
|
||||||
|
##### list modules
|
||||||
|
|
||||||
#### Plugin management commands
|
#### Plugin management commands
|
||||||
|
|
||||||
|
##### plug
|
||||||
|
##### unplug
|
||||||
|
##### pluglist
|
||||||
|
|
||||||
|
#### Command metadata commands
|
||||||
|
|
||||||
|
##### cmdset
|
||||||
|
##### cmdunset
|
||||||
|
|
||||||
#### Registry commands
|
#### Registry commands
|
||||||
|
|
||||||
|
##### regset
|
||||||
|
##### regunset
|
||||||
|
##### regchange
|
||||||
|
##### regshow
|
||||||
|
##### regfind
|
||||||
|
##### regsetmeta
|
||||||
|
##### regunsetmeta
|
||||||
|
|
||||||
#### Miscellaneous admin commands
|
#### Miscellaneous admin commands
|
||||||
|
|
||||||
|
##### export
|
||||||
|
##### refresh
|
||||||
|
##### reload
|
||||||
|
##### sl
|
||||||
|
##### die
|
||||||
|
|
||||||
### Factoid commands
|
### Factoid commands
|
||||||
|
|
||||||
#### Adding factoids
|
#### [fact](Factoids.md#fact)
|
||||||
|
#### factadd
|
||||||
#### Viewing factoids
|
#### factrem
|
||||||
|
#### factshow
|
||||||
#### Deleting factoids
|
#### factchange
|
||||||
|
#### factalias
|
||||||
#### Aliasing commands
|
#### factmove
|
||||||
|
#### factundo
|
||||||
#### Moving/renaming factoids
|
#### factredo
|
||||||
|
#### factlog
|
||||||
#### Editing factoids
|
#### factset
|
||||||
|
#### factunset
|
||||||
#### Information about a factoid
|
#### factfind
|
||||||
|
#### factinfo
|
||||||
|
#### count
|
||||||
|
#### histogram
|
||||||
|
#### top20
|
||||||
|
|
||||||
### Miscellaneous commands
|
### Miscellaneous commands
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user