ADVENTURE

   1 Welcome to hatexmpp.
   2
   3 > look
   4
   5 You are near the root of a tree.
   6
   7 > look hatexmpp
   8
   9 You see a xmpp client with filesystem frontend.
  10
  11 > configure hatexmpp
  12
  13 Okay: $EDITOR config.h
  14 Enjoy the comments inside.
  15
  16 > build hatexmpp
  17
  18 Okay: make
  19 You will need glib (~>=2.18.4), fuse (~>=2.7.4) and loudmouth (~>=1.4.3)
  20 in your system to proceed with compilation.
  21 On BSD machines you may need to say gmake instead.
  22 It wasn't tested on Windows, though. If you do, CONTACT us.
  23
  24 > run hatexmpp
  25
  26 Synopsis: ./hatexmpp <mountpoint> [-d]
  27 mountpoint - a directory where the hatexmpp tree will be deployed
  28 d - enable it to debug
  29
  30 > go fs
  31
  32 You see config, events, log, rawxmpp and roster
  33
  34 > go config
  35
  36 You see the place filled with different xmpp-related configuration options
  37
  38 > look
  39
  40 jiv_name - the client name to be published
  41 jiv_os - operating system name
  42 jiv_version - version of the client
  43 muc_default_nick - default nickname to be used while joining the conferences
  44 password - password for your xmpp account
  45 port - TCP port number of the server
  46 priority - the priority of the selected resource
  47 resource - xmpp resource name
  48 server - address of the server to connect to
  49 show - XMPP machine-readable "status" value, can be "", "away", "chat", "dnd" and "xa"
  50 ssl - enable or disable SSL; valid values are "disabled", "enabled", "starttls" and "required_starttls"
  51 status - human-readable status
  52 username - username
  53 register - create this to make xmpp to register a new account on the server
  54 based on the stated username and password
  55 noauth - create to prevent auth after bringing up the connection; may be used
  56 to do weird things with raw xml stream access
  57 auto_reconnect - create to reconnect on disconnection; still unusable
  58 raw_logs - raw logs (without time, jids)
  59 events - events generation on/off
  60
  61 > go /
  62 > use hatexmpp
  63
  64 command - action[ - comment]
  65 hatexmpp -h - command line options description
  66 mkdir roster - connect to server
  67 rmdir roster - disconnect
  68 cp opt config/ - write config option "opt"
  69 mkdir roster/mucjid - join MUC "mucjid"
  70 rmdir roster/mucjid - part MUC "mucjid"
  71 echo -n lol >> roster/jid/__chat - say "lol" to "jid"
  72 echo -n lol >> roster/jid/resource - say "lol" to "jid"'s "resource
  73 echo -n lol >> roster/mucjid/__chat - say "lol" to MUC "mucjid"
  74 echo -n lol >> roster/mucjid/nick - say "lol" to MUC "mucjid" participant "nick"
  75 rm roster/jid - remove "jid" from roster
  76 rm roster/mucjid/jid - ban "jid" in MUC "mucjid" - temporary
  77 rm roster/mucjid/nick - ban "nick" in MUC "mucjid" - not implemented
  78 echo -n > roster/mucjid/nick - kick "nick" in MUC "mucjid" - not implemented/wtf!?
  79 tail -f roster/jid/__chat - listen to jid's talk - temporary
  80 tail -f roster/mucjid/__chat - listen to mucjid - temporary
  81 cat /path/to/stream - continiously listen to stream - not implemented
  82 echo -n lol >> roster/mucjid/__nick - change nickname
  83
  84 > go frontends
  85
  86 You see some frontends to use with hatexmpp.
  87
  88 > go hatebot
  89
  90 You see the hatexmpp-based MUC bot.
  91
  92 > look
  93
  94 You see some bash scripts:
  95 cmdlex.sh - the script which actually interacts with hatexmpp
  96 cmdparse.sh - running and cutting the output of the commands
  97 getfup.sh - setting the bot up
  98 getbot.sh - the script preparing the environment for the getfup.sh,
  99 setting the MUCs to sit on and enables logging.
 100 shutdown.sh - shuts down the bot
 101
 102 Also, there are some directories ahead:
 103 commands - the commands hatebot will run on the users' requests
 104 config - the folder to copy to fs/config
 105
 106 > go commands
 107
 108 You see a lot of scripts, you feel a little dizzy.
 109
 110 > look
 111
 112 All the commands boil down to simple interface: they are running with their
 113 filenames and arguments set in the chat just like in the shell. Their output
 114 is redirected to the chat. Also, they may use "C" environment variable to get
 115 the name of MUC they were called from.
 116
 117 > go /
 118 > bugs
 119
 120 Sure, lots of them! The known ones are broken events and failing to cut all
 121 the illegal symbols from the user-supplied messages.
 122
 123 > quit
 124
 125 Till next time, adventurer!
 126 Thanks to the vx32 authors for their ADVENTURE!
 127