Pichat plugins
Last update 06/Jul/2009 by Mark Seuffert and David Fehrmann
Overview:
1. Introduction2.1. Plugin logbot
2.2. Plugin quizbot
2.3. Plugin webcam
2.4. Plugin webstatus
2.5. Plugin winamp
3. Beta plugins
4. Installation of plugins
1. Introduction
This document is for users who want to extend their chat with new features. With plugins you can
add new functionality, for example show a webcam picture and integrate chat bots. For developers
there is also a software development kit (Pichat SDK) to create your own plugins.
To download plugins please see Pichat downloads.
2.1. Plugin logbot
The logbot plugin records conversations on the chat server. A logbot joins chatrooms and writes
chat text into logfiles, only configured chatrooms will be logged. Private messages between users
are never recorded. When installing this plugin please make sure that users will be informed that
public conversations are logged, for example in the MOTD (message of the day) when entering the
chat.
| Syntax: | /PLUGIN Bot.Log START nickname chatroom [language] | ||||||||||||||||||
| /PLUGIN Bot.Log STOP nickname | |||||||||||||||||||
| /PLUGIN Bot.Log RELOAD | |||||||||||||||||||
| Arguments: |
| ||||||||||||||||||
| Example: | /PLUGIN Bot.Log START Logbot Clubroom |
| Settings: | [Bot.Log] | ||||||||||||||
|
2.2. Plugin quizbot
The quizbot plugin runs a quiz in a chatroom. A question and answer session consists of multiple
questions and each correct answer counts one point. The quizbot gives suggestions. If no user knows
the right answer the correct answer will be revealed. At the end of a quiz the user with the most
points wins. You can create your own quiz questions, have a look at the example questions
in the downloads section.
| Syntax: | /PLUGIN Bot.Quiz START nickname chatroom quiz [language] | |||||||||||||||||||||
| /PLUGIN Bot.Quiz STOP nickname | ||||||||||||||||||||||
| /PLUGIN Bot.Quiz RELOAD | ||||||||||||||||||||||
| Arguments: |
| |||||||||||||||||||||
| Examples: | /PLUGIN Bot.Quiz START Quizbot Entrance Funny | |||||||||||||||||||||
| /PLUGIN Bot.Quiz STOP Quizbot |
| Commands: | The quizbot understands the following commands in the chatroom... | ||||||||||||||
| |||||||||||||||
| Settings: | [Bot.Quiz] | ||||||||||||||
|
2.3. Plugin webcam
The webcam plugin shows a webcam picture. There is also a small preview windows which indicates if
somebody is watching your webcam. When the plugin is installed you will see the webcam picture at
http://127.0.0.1/webcam or http://myserver/webcam (default settings). Please replace 'myserver'
with the public address of your own server. You can integrate the picture into your webchat, have
a look at the example files in the downloads section.
| Syntax: | /PLUGIN Webcam.Picture CAPTURE | |||||||||||||||
| /PLUGIN Webcam.Picture PREVIEW | ||||||||||||||||
| /PLUGIN Webcam.Picture DEVICE | ||||||||||||||||
| /PLUGIN Webcam.Picture FORMAT | ||||||||||||||||
| /PLUGIN Webcam.Picture RELOAD | ||||||||||||||||
| Arguments: |
| |||||||||||||||
| Example: | /PLUGIN Webcam.Picture CAPTURE |
| Settings: | [Webcam.Picture] | ||||||||||||||||||||||||||||||||||||||||||
|
2.4. Plugin webstatus
The webstatus plugin offers additional chat status information, a list of chat users in TEXT or XML
format. When the plugin is installed you can access it at http://127.0.0.1/chatstatus/userlist.txt or
http://myserver/chatstatus/userlist.txt (default settings). Please replace 'myserver' with the public
address of your own server.
| Syntax: | /PLUGIN Web.Status STATUS | ||||||
| /PLUGIN Web.Status RELOAD | |||||||
| Arguments: |
|
| Settings: | [Web.Status] | ||||||
|
2.5. Plugin winamp
The Winamp plugin shows current song played in the Winamp media player.
| Syntax: | /PLUGIN Winamp.Notify SHOW | |||||||||
| /PLUGIN Winamp.Notify AUTOMATIC | ||||||||||
| /PLUGIN Winamp.Notify RELOAD | ||||||||||
| Arguments: |
| |||||||||
| Example: | /PLUGIN Winamp.Notify SHOW |
| Settings: | [Winamp.Notify] | ||||||||
|
3. Beta plugins
There are more plugins which have not been released into public yet, they are for testers only.
Here we try new ideas and features. Beta plugins have not reached sufficient software quality and
probably need more time for testing. We can not guarantee that any of these plugins are free from
defects or will be updated regularly. Please get in touch if you are interested.
Here is an overview of available beta plugins:
- Plugin annabot - Anna is a multi purpose chatroom service bot, she helps to manage chatrooms and large chat communities
- Plugin audio - A voice chat extension for the chat. This plugin is early beta state and only David really knows what it does
- Plugin register - A web administration interface for user management. Chat users can register, change their profile and password
- Plugin skin - A skinning plugin to customise the Windows user interface. It allows to use new graphics and backgrounds
- Plugin talkbot - The talkbot is an experimental bot that can talk with users in the chat and answer common questions
- Plugin whiteboard - A web-based whiteboard where users can write and draw, great for collaboration. It supports colors and images
4. Installation of plugins
Download and copy plugins into the Pichat program directory (where your pichat.exe is), then restart
Pichat. You can see which plugins are installed with the /PLUGIN command
in the chat.
There is an INI file to hold all your personal plugin settings. It is called 'pichat_plugins.ini'
and stored in the Pichat data directory in your home directory. On Windows you'll find it where
your documents and settings are stored, enter %APPDATA% in Windows Explorer. You need to run a
plugin at least once to create its settings.
If you need help or have ideas for new features, please talk with other users in the
chat. 
