octoleo
/
telegram-bot-bash
mirror of https://github.com/octoleo/telegram-bot-bash.git
1
1
Fork 0
Code Issues Projects Releases Wiki Activity

update doc

This commit is contained in:
Kay Marquardt (Gnadelwartz) 2020-06-07 14:32:18 +02:00
parent 5fc4d01a51
commit 3fcb8547e8
2 changed files with 29 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
doc/2_usage.md
View File

@ -17,42 +17,44 @@ Have FUN!
### Files ### Files
``` ```
. .
├── mycommands.sh # THIS is your bot, place logic and commands here! ├── mycommands.sh # THIS is your bot, place logic and commands here!
│ │
├── mycommands.sh.clean # copy to "mycommands.sh" if you start devloping your bot ├── mycommands.sh.clean # copy to "mycommands.sh" if you start devloping your bot
├── mycommands.sh.dist # example bot, also used for testing bashbot internally ├── mycommands.sh.dist # example bot, also used for testing bashbot internally
│ │
├── count.jssh # count bashbot usage in jssh key-value store ├── count.jssh # count bashbot usage in jssh key-value store
├── blocked.jssh # list of blocked USER[ID] in jssh key-value store ├── blocked.jssh # list of blocked USER[ID] in jssh key-value store
│ │
├── bashbot.sh # main bashbot script - DO NOT EDIT! ├── bashbot.sh # main bashbot script - DO NOT EDIT!
├── commands.sh # command dispatcher - DO NOT EDIT! ├── commands.sh # command dispatcher - DO NOT EDIT!
├── JSON.sh # bashbots JSON parser, see https://github.com/dominictarr/JSON.sh ├── JSON.sh # bashbots JSON parser, see https://github.com/dominictarr/JSON.sh
│ │
├── scripts # place your bashbot interactive and background scripts here ├── scripts # place your bashbot interactive and background scripts here
├── logs # here you'll find ERROR, DEBUG and MESSAGE.log │   └── interactive.sh.clean # interactive script template for new scripts
│ │
├── modules # optional functions, sourced by commands.sh ├── logs # here you'll find ERROR, DEBUG and MESSAGE.log
│   ├── aliases.sh # to disable modules rename them xxx.sh.off │
├── modules # optional functions, sourced by commands.sh
│   ├── aliases.sh # to disable modules rename them xxx.sh.off
│   ├── answerInline.sh │   ├── answerInline.sh
│   ├── jsshDB.sh # read and store JSON.sh stlye JSON, mandatory │   ├── jsshDB.sh # read and store JSON.sh stlye JSON, mandatory
│   ├── background.sh # interactive and background functions │   ├── background.sh # interactive and background functions
│   ├── chatMember.sh │   ├── chatMember.sh
│   └── sendMessage.sh # main send message functions, mandatory │   └── sendMessage.sh # main send message functions, mandatory
│ │
├── addons # optional addons, disbaled by default ├── addons # optional addons, disbaled by default
│   ├── example.sh # to enable addons change their XXX_ENABLE to true │   ├── example.sh # to enable addons change their XXX_ENABLE to true
│   ├── antiFlood.sh # simple addon taking actions based on # files and text sent to chat │   ├── antiFlood.sh # simple addon taking actions based on # files and text sent to chat
│   └── xxxxxage.sh │   └── 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
│   ├── README.md # description of files and examples │   ├── README.md # description of files and examples
│   ├── bash2env.shh # script to convert /bin/bash shebang to /usr/bin/env, see [Security Considerations](../README.md#Security-Considerations) │   ├── bash2env.sh # script to convert shebang to /usr/bin/env, see [Security Considerations](../README.md#Security-Considerations)
│   └── bashbot.cron # example crontab │   └── bashbot.cron # example crontab
│ │
├── doc # Documentation and License ├── doc # Documentation and License
├── html ├── html
├── LICENSE ├── LICENSE
├── README.html ├── README.html
@ -254,5 +256,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.96-dev3-4-gbc74141 #### $$VERSION$$ v0.96-dev3-14-g5fc4d01a

4
examples/question.sh
View File

@ -5,7 +5,7 @@
# This file is public domain in the USA and all free countries. # This file is public domain in the USA and all free countries.
# Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying) # Elsewhere, consider it to be WTFPLv2. (wtfpl.net/txt/copying)
# #
#### $$VERSION$$ v0.96-dev3-12-g3f85134 #### $$VERSION$$ v0.96-dev3-14-g5fc4d01a
###### ######
# parameters # parameters
@ -34,7 +34,7 @@ until [ "$SUCCESS" = "y" ] ;do
case $answer in case $answer in
'Yass!') echo "Goody! mykeyboardendshere";SUCCESS=y;; 'Yass!') echo "Goody! mykeyboardendshere";SUCCESS=y;;
'No') echo "Well that's weird. mykeyboardendshere";SUCCESS=y;; 'No') echo "Well that's weird. mykeyboardendshere";SUCCESS=y;;
'') echo "empty answer!" && cleanup "$3";; '') echo "empty answer!" && exit ;;
*) SUCCESS=n;; *) SUCCESS=n;;
esac esac
done done