sblorgo/README

74 lines
2.2 KiB
Plaintext

'|| '||`
|| ||
('''' ||''|, || .|''|, '||''| .|''|, .|''|,
`'') || || || || || || || || || ||
`...' .||..|' .||. `|..|' .||. `|..|| `|..|'
||
`..|'
an IRC bot written in bash
features -------------------------------------
- libera.chat services integration
- administrative commands
- fun commands
- spaghetti code. lots and lots.
- easy to extend, since it's written in bash.
- quite light, coming in at ~250 SLOC
- easy to run on more than 1 channel
installation ---------------------------------
to install sblorgo, you first need to get the
dependencies, which are:
- bash (duh!)
- ii
- tput
- sed
- awk
after you've installed all that, clone this
repo and edit sblorgo.sh and start.sh to your
liking. after that, open up a terminal and
run start.sh, then open another terminal and
run sblorgo.sh in it.
command list ---------------------------------
default prefix is ":".
legend: <> = required, () = optional
coffee (user) - drink coffee or share it.
tea (user) - same thing as coffee.
fortune - give the user a fortune.
uptime - send host server's uptime.
about - show information about the bot.
rr - play a game of russian roulette.
coinflip - flip a coin.
dice - roll the dice.
uname - send host server's uname.
time - send current time in unix format.
penis (user) - measure a user's e-penis.
hey - greet the user. first command added!
ping - pong.
test <condition> - see if argument is true.
8ball <query> - ask the oh so wise 8-ball.
grep <text> - search channel logs for text.
wgrep <text> - see word count for text.
sendops <text> - send a message to bot ops.
op - op yourself if you're permitted to.
deop - same as above, but it's the opposite.
voice - voice yourself if you're permitted to.
devoice - oh come on, just take a guess.
help - show a list of commands
contributors ---------------------------------
as of now, it's just jornmann. if you'd like
to change that, I'd be forever grateful :D
however, there is a list of requirements:
- make sure that you can work with messy code.
- make sure you can write bash scripts.
- make sure you follow the other requirements.
yep, that's it. your contributions will be
licensed under AGPL.