botanirc

botany as an irc bot
git clone git://shroom.party/botanirc.git
Log | Files | Refs | README | LICENSE

README (2930B)


      1 |-----------------------------( botanirc )-------------------------------|
      2 
      3 this is a rewrite of jifunks (Jacob Funke) botany for IRC
      4 https://github.com/jifunks/botany
      5 
      6 art, species, mutations, etc. are taken from botany source code, therefore
      7 botany license file is reproduced in BOTANY_LICENSE
      8 
      9 this is not a 100% accurate clone: some features may be missing, time may
     10 not be handled the same way, etc.
     11 
     12 botanirc is a sopel irc bot module, get it from there: https://sopel.chat/
     13 
     14 |---------------------------( installation )-----------------------------|
     15 
     16 copy botanirc.py in your sopel module directory (e.g. ~/.sopel/modules/)
     17 copy botanirc_art in your sopel working directory
     18 
     19 botanirc requires the following python modules:
     20 - dateutil for readable time and time deltas
     21 - filelock to lock ini file
     22 
     23 get it from your package manager or pip with `pip install dateutil`
     24 
     25 you can restrict botany from being used on a channel (to avoid spam) by
     26 uncommenting the lines starting with `#@module.require_privmsg`
     27 
     28 |---------------------------( configuration )----------------------------|
     29 
     30 use [botanirc] configuration section of your sopel bot.
     31 
     32 - export_path:      where the garden should be exported
     33 - export_url:       where the garden will be accessible from
     34 - export_footer:    an optional footer for the garden export
     35 - cfg_path:         where plants are stored, default ~/.sopel/botanirc.ini
     36 - garden_whitelist: optional list of nicks allowed to use garden command
     37 
     38 here is an example of ~/.sopel/default.cfg with default values:
     39 
     40 	...
     41 	[botanirc]
     42 	export_path = /tmp/garden.txt
     43 	export_url = gopher://myawesomegarden.tld/0/garden.txt
     44 	...
     45 
     46 plants data are be stored in sopel configuration directory, by default
     47 this should be ~/.sopel/botanirc.ini
     48 
     49 |-------------------------------( usage )--------------------------------|
     50 
     51 commands:
     52 
     53 .seed [name] (channel message): seed a new plant with a given name
     54 .seed [name] (private message): seed a new plant with a given name for you
     55 .refill: refill water
     56 .plant: show current plant stats and art
     57 .garden: update all plants and export the garden
     58 
     59 plants overwatered will eventually get sick, let them dry just a bit once
     60 every 3 days.
     61 
     62 |----------------------------( screenshot )------------------------------|
     63 
     64 15:03:39 <trqx> .plant
     65 15:03:40 <bota>                          name:   alpha
     66 15:03:41 <bota>                          owner:  #botanirc
     67 15:03:41 <bota>            +*+,          specie: cactus [ fractal ]
     68 15:03:42 <bota>        *+\/|`* \         stage:  flowering
     69 15:03:42 <bota>        \'  | |'| .,      age:    23 days, 5 minutes
     70 15:03:43 <bota>         * `| | |/ )      color:  orange
     71 15:03:44 <bota>          | |'| , /       rarity: common
     72 15:03:45 <bota>          |'| |, /        soil:   soaked
     73 15:03:46 <bota> .  , _ . |_|_| | ., _ .  health: ok
     74 15:03:46 <bota>   ^      '        `    '
     75 
     76 |--------------------------------( EOF )---------------------------------|