octoleo/telegram-bot-bash
1
1
Fork 0
mirror of https://github.com/octoleo/telegram-bot-bash.git synced 2024-11-26 09:16:28 +00:00
Code Issues Projects Releases Wiki Activity

prepare doc for addons

Browse Source
This commit is contained in:
Kay Marquardt (Gnadelwartz) 2019-05-25 14:06:41 +02:00
parent 43372f5278
commit 9f74bcfec4
1 changed files with 11 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/2_usage.md
View File

@ -1,17 +1,19 @@
#### [Home](../README.md) #### [Home](../README.md)
## Gettting Started ## Gettting Started
The Bots standard commands are in ```commands.sh``` file. Do not edit 'commands.sh', instead add your commands and functions to ```mycommands.sh```. In 'mycommands.sh.dist' you will find examples how add your own commands and overwrtie existing ones. See [Best practices](5_practice.md) for more information. The Bots standard commands are in the commands dispatcher ```commands.sh```, Do not edit this file! Add your commands and functions to ```mycommands.sh```. In 'mycommands.sh.dist' you find examples how to add own commands and overwrite existing ones. See [Best practices](5_practice.md) for more information.
Once you're done with editing 'mycommands.sh' start the Bot with ```./bashbot.sh start```. To stop the Bot run ```./bashbot.sh kill``` Once you're done with editing start the Bot with ```./bashbot.sh start```. To stop the Bot run ```./bashbot.sh kill```
If something doesn't work as expected, you can debug with ```./bashbot.sh startbot DEBUG``` where DEBUG can be 'debug', 'xdebug' or 'xdebugx'. If something doesn't work as expected, debug with ```./bashbot.sh startbot DEBUG```, where DEBUG can be 'debug', 'xdebug' or 'xdebugx'.
See [Bashbot Development](7_develop.md) for more information. See [Bashbot Development](7_develop.md) for more information.
To use the functions provided in this script in other scripts simply source bashbot: ```source bashbot.sh source```. see [Expert Use](8_expert.md#Expert-use) To use the functions provided in this script in other scripts simply source bashbot: ```source bashbot.sh source```. see [Expert Use](8_expert.md#Expert-use)
Have FUN! Have FUN!
----
### Files ### Files
``` ```
. .
@ -23,10 +25,15 @@ Have FUN!
├── modules # optional functions, sourced by commands.sh ├── modules # optional functions, sourced by commands.sh
│   ├── aliases.sh # to disable modules rename them xxx.sh.off │   ├── aliases.sh # to disable modules rename them xxx.sh.off
│   ├── answerInline.sh │   ├── answerInline.sh
│   ├── jsonDB.sh
│   ├── background.sh │   ├── background.sh
│   ├── chatMember.sh │   ├── chatMember.sh
│   └── sendMessage.sh # main send message functions, do not disable │   └── sendMessage.sh # main send message functions, do not disable
│ │
├── addons # optional addons, disbaled by default
│   ├── example.sh # to enable addons change their XXX_ENABLE to true
│   └── xxxxxage.sh
│
├── bashbot.rc # start/stop script if you run basbot as service ├── bashbot.rc # start/stop script if you run basbot as service
│ │
├── examples # example scripts and configs for bashbot ├── examples # example scripts and configs for bashbot
@ -214,5 +221,5 @@ send_action "${CHAT[ID]}" "action"
#### [Prev Create Bot](1_firstbot.md) #### [Prev Create Bot](1_firstbot.md)
#### [Next Advanced Usage](3_advanced.md) #### [Next Advanced Usage](3_advanced.md)
#### $$VERSION$$ v0.80-24-g68bee46 #### $$VERSION$$ v0.80-25-g43372f5