supermeetbot

git clone git://shroom.party/supermeetbot.git
Log | Files | Refs | README | LICENSE

README (2608B)


      1 |---------------------------( supermeetbot )-----------------------------|
      2 
      3 a sopel meeting module
      4 
      5 |---------------------------( configuration )----------------------------|
      6 
      7 put in your sopel configuration file:
      8 
      9 	[supermeetbot]
     10 	export_base_path= /var/www/meetings     # minutes export directory
     11 	export_base_url= https://meetings.tld/  # base url to get the minutes
     12 
     13 |-----------------------------( commands )-------------------------------|
     14 
     15 - meetstart [subject] (start a meeting)
     16 - subject             (set meeting subject)
     17 - members nick1,...   (define members of the meeting)
     18 - info                (add an info)
     19 - agreed              (add an agreement)
     20 - action              (add an action)
     21 - meetwip             (generate a wip of the minutes of meeting)
     22 - meetstop            (stop a meeting)
     23 
     24 |------------------------------( logging )-------------------------------|
     25 
     26 Everything is logged unless members of the meeting are defined. Anyone can
     27 send a unlogged message by including "#oom" (out of meeting) string.
     28 
     29 The minutes of meeting are generated at the end of the meeting and can be
     30 triggered at anytime using the meetwip command.
     31 
     32 |------------------------( exemple of minutes )--------------------------|
     33 
     34 supermeetbot demo - 2019-02-26
     35 ==============================
     36 
     37 subj: supermeetbot demo
     38 chan: #tmp
     39 time: 2019-02-26 08:52
     40 head: tx
     41 
     42 members
     43 -------
     44 
     45 - tx
     46 - trqx
     47 - deviant
     48 
     49 infos
     50 -----
     51 
     52 - bla bla !
     53 
     54 agreed
     55 ------
     56 
     57 - blablabla
     58 - don't blablabla
     59 
     60 actions
     61 -------
     62 
     63 - build a bigger bikeshed
     64 
     65 full log
     66 --------
     67 
     68 2019-02-26 08:52  meeting started by tx: supermeetbot demo (#tmp)
     69 2019-02-26 08:52  unless members of the meeting have been defined, all your messages will be logged until end of the meeting. you can then '#oom' (out of meeting) to prevent the logging of a particular message
     70 2019-02-26 08:53  MEMBERS: tx, trqx, deviant (set by tx)
     71 2019-02-26 08:53  <tx> bla bla bla
     72 2019-02-26 08:53  <trqx> xbla bla
     73 2019-02-26 08:53  INFO: bla bla ! (added by trqx)
     74 2019-02-26 08:53  <tx> yay
     75 2019-02-26 08:54  AGREED: blablabla (added by tx)
     76 2019-02-26 08:54  <trqx> do we need to do blablabla then ?
     77 2019-02-26 08:54  <tx> bla !
     78 2019-02-26 08:54  <trqx> ok
     79 2019-02-26 08:54  AGREED: don't blablabla (added by trqx)
     80 2019-02-26 08:54  <tx> bla bla, we need a bigger bikeshed
     81 2019-02-26 08:55  <trqx> let's do it
     82 2019-02-26 08:55  ACTION: build a bigger bikeshed (added by tx)
     83 2019-02-26 08:56  <tx> ok we can wrap it up
     84 2019-02-26 08:56  <trqx> zeng!
     85 2019-02-26 08:56  meeting ended by tx: supermeetbot demo (#tmp)
     86 
     87 |--------------------------------( EOF )---------------------------------|