Firepup650/bitbot-3.11-fork
2
0
Fork 0
Code Issues Pull requests Activity Actions

Replace "<" with "&lt;"

Browse source
This commit is contained in:
jesopo 2019-04-15 17:04:43 +01:00
parent f19fa24044
commit 0b84c879d4
1 changed files with 15 additions and 15 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
docs/help/setup.md
View file

@ -5,9 +5,9 @@
* Run `./start.py -m permissions -M master-password` to get the master admin password (needed to add regular admin accounts)
* Run `./start.py` to start the bot.
* Join `#bitbot` on a server with the bot (or invite it to another channel)
* `/msg <bot> register <password here>` to register your nickname with the bot
* `/msg <bot> masterlogin <master admin password>` to login as master admin
* `/msg <bot> givepermission <your nickname> *` to give your account admin permissions
* `/msg &lt;bot> register &lt;password here>` to register your nickname with the bot
* `/msg &lt;bot> masterlogin &lt;master admin password>` to login as master admin
* `/msg &lt;bot> givepermission &lt;your nickname> *` to give your account admin permissions
### Configure client TLS certificate
@ -19,34 +19,34 @@ Configure the bot to use SASL to authenticate (usually used for `NickServ` ident
`EXTERNAL` usually mean client TLS certificate authentication; `USERPASS` is a BitBot-specific term that selects the strongest user/password algorithm.
> /msg <bot> config server sasl userpass &lt;username>:&lt;password>
> /msg &lt;bot> config server sasl userpass &lt;username>:&lt;password>
> /msg <bot> config server sasl plain &lt;username>:&lt;password>
> /msg &lt;bot> config server sasl plain &lt;username>:&lt;password>
> /msg <bot> config server sasl scram-sha-1 &lt;username>:&lt;password>
> /msg &lt;bot> config server sasl scram-sha-1 &lt;username>:&lt;password>
> /msg <bot> config server sasl scram-sha-256 &lt;username>:&lt;password>
> /msg &lt;bot> config server sasl scram-sha-256 &lt;username>:&lt;password>
> /msg <bot> config server sasl external
> /msg &lt;bot> config server sasl external
### Commands on-connect
The `perform.py` module allows the bot to execute a saved list of raw IRC commands against a server it's connecting to. Use `/msg <bot> performadd <raw irc command>` to add to the current server's list of commands (`%nick%` in a raw command will be replaced with the bot's current nick.)
The `perform.py` module allows the bot to execute a saved list of raw IRC commands against a server it's connecting to. Use `/msg &lt;bot> performadd &lt;raw irc command>` to add to the current server's list of commands (`%nick%` in a raw command will be replaced with the bot's current nick.)
### Config options
#### View available config options
> /msg <bot> config bot|server|channel|user
> /msg &lt;bot> config bot|server|channel|user
#### Set config options
> /msg <bot> config bot <setting> <value>
> /msg &lt;bot> config bot &lt;setting> &lt;value>
> /msg <bot> config server <setting> <value>
> /msg &lt;bot> config server &lt;setting> &lt;value>
> /msg <bot> config channel:#bitbot <setting> <value>
> /msg &lt;bot> config channel:#bitbot &lt;setting> &lt;value>
> /msg <bot> config user <setting> <value>
> /msg &lt;bot> config user &lt;setting> &lt;value>
> /msg <bot> config user:other_user <setting> <value>
> /msg &lt;bot> config user:other_user &lt;setting> &lt;value>