Pichat Plugins

Dieses Dokument richtet sich an Benutzer die ihren Chat erweitern wollen. Mit Plugins kann man neue Funktionen hinzufügen, zum Beispiel ein Webcambild anzeigen oder einen Chatbot einbauen. Für Entwickler gibt es außerdem ein Software Development Kit (Pichat SDK) um eigene Plugins zu erstellen.

Zum Herunterladen von Plugins siehe Pichat Downloads.

Das einfache Benutzerauthentifizierung-Plugin verwaltet Authentifizierung für den Chat und Web-Server. Alle Benutzerdaten werden, einschließlich Kennwörter als SHA256-Hash oder Klartext, in einer Textdatei gespeichert. Das pipasswd-Programm kann verwendet werden, um die Authentifizierungsdatei zu erstellen oder zu aktualisieren. Man kann beispielsweise registrierte Benutzer und Chat-Admins hinzuzufügen oder Benutzerbeschreibungen ändern.

Syntax:	/PLUGIN Authentication.Plain STATUS
	/PLUGIN Authentication.Plain RELOAD
Argumente:	STATUS = zeige kurzen Status an, Anzahl der Zugriffe RELOAD = lade Einstellungen neu

Einstellungen:	[Authentication.Plain]
	UserAuthenticationFile Authentifizierungsdatei

Das Sprach-Plugin aktualisiert automatisch die europäische Sprachdatei für den Chatserver.

Hier ist eine Liste mit vorhandenen Sprachen:

• bg - Bulgarisch von Ognian Petrov
• bs - Bosnisch von Alen Okic
• de - Deutsch von Mark Seuffert (eingebaut)
• en - Englisch von Mark Seuffert (eingebaut)
• fr - Französisch von Thomas Pereira
• hu - Ungarisch von Miko Robert
• sv - Schwedisch von Magnus Lindgren (eingebaut)

Es gibt keine Einstellungen für dieses Plugin. Die europäische Sprachdatei heißt "pichat_languages_europe.txt" und wird automatisch ins Pichat-Verzeichnis geschrieben (oder dort wo die Plugin-Einstellungen gespeichert sind). Wir freuen uns auf weitere Übersetzungen!

Das Logbot-Plugin zeichnet Unterhaltungen auf dem Chatserver mit. Ein Logbot betritt Chaträume und schreibt Chattext in Logdateien, nur konfigurierte Chaträume werden mitgeloggt. Private Nachrichten zwischen Benutzern werden niemals aufgezeichnet. Wenn dieses Plugin installiert wird sollte man sicherstellen dass Benutzer darüber informiert werden dass öffentliche Unterhaltungen mitgeloggt werden, zum Beispiel in der MOTD (Nachricht des Tages) beim Betreten des Chats.

Syntax:	/PLUGIN Bot.Log START name chatraum [sprache]
	/PLUGIN Bot.Log STOP name
	/PLUGIN Bot.Log RELOAD
Argumente:	START = starte Logging STOP = beende Logging RELOAD = lade Einstellungen neu name = Name des Bots chatraum = Name des Chatraums sprache = bevorzugte Sprache (keine für Englisch)
Beispiel:	/PLUGIN Bot.Log START Logbot Clubraum

Einstellungen:

[Bot.Log]

BotNickname Botname BotAuthentication optionaler Benutzername und Passwort (Format "benutzer:passwort") Chatrooms Namen von Chaträumen die geloggt werden sollen, Komma getrennter Text ChatroomsPermanent logge permanente Chaträume? boolscher Wert LogfilesSizeMax maximale Dateigröße die Logdateien anwachsen dürfen (Bytes), 0 bedeutet unbegrenzt LogfilesDirectory Verzeichnis um Logdateien abzuspeichern Logfile Logdatei, %c und %C stehen für den Chatraum

Das Quizbot-Plugin betreibt ein Quiz in einem Chatraum. Eine Fragerunde besteht aus mehreren Fragen und jede richtige Antwort zählt einen Punkt. Der Quizbot macht Vorschläge. Falls kein Benutzer die richtige Antwort weiß wird die korrekte Antwort preisgegeben. Am Ende des Quizes gewinnt der Benutzer mit den meisten Punkten. Man kann seine eigenen Quizfragen erstellen.

Syntax:	/PLUGIN Bot.Quiz START name chatraum quiz [sprache]
	/PLUGIN Bot.Quiz STOP name
	/PLUGIN Bot.Quiz RELOAD
	/PLUGIN Bot.Quiz EXTRACT
Argumente:	START = starte ein Quiz STOP = beende ein Quiz RELOAD = lade Einstellungen neu EXTRACT = extrahiere Vorlagen zum Angleichen (Beispielsfragen, Sprachdatei) name = Name des Bots chatraum = Name des Chatraums quiz = Name des Quizes sprache = bevorzugte Sprache (keine für Englisch)
Beispiele:	/PLUGIN Bot.Quiz START Quizbot Entrance Funny
	/PLUGIN Bot.Quiz STOP Quizbot

Chatbefehle:	Der Quizbot versteht die folgenden Befehle im Chatraum...
	!quizstatus = Zeige aktuellen Quizstatus an !quiztrivia = Zeige eine Liste mit vorhandenen Wissensbereichen an
Einstellungen:	[Bot.Quiz]
	TriviaPack Datei mit Quizfragen LanguagePack Datei mit weiteren Sprachen BotAuthentication optionaler Benutzername und Passwort (Format "benutzer:passwort") QuestionRounds Anzahl Runden pro Wissensbereich (Standard ist 1) QuestionTimeout Zeit um eine Frage zu beantworten (Sekunden) QuestionTimeoutTip Zeit bevor ein Tipp angezeigt wird (Sekunden) QuestionDelay Verzögerung zwischen Fragen (Sekunden)

Das Webcam-Plugin zeigt ein Webcambild an. Außerdem gibt es ein kleines Vorschaufenster, welches anzeigt ob jemand auf die Webcam zugreift. Wenn das Plugin installiert ist findet man das Webcambild unter http://127.0.0.1/webcam oder http://myserver/webcam (Standardeinstellungen). Bitte ersetze "myserver" mit der öffentlichen Adresse deines eigenen Servers.

Syntax:	/PLUGIN Webcam.Picture CAPTURE
	/PLUGIN Webcam.Picture PREVIEW
	/PLUGIN Webcam.Picture DEVICE
	/PLUGIN Webcam.Picture FORMAT
	/PLUGIN Webcam.Picture RELOAD
	/PLUGIN Webcam.Picture EXTRACT
Argumente:	CAPTURE = schalte Webcam ein/aus PREVIEW = zeige/verstecke Vorschaufenster DEVICE = zeige Hardwareeinstellungen FORMAT = zeige Formateinstellungen (Webcam-Einstellungen) RELOAD = lade Einstellungen neu EXTRACT = extrahiere Vorlagen zum Angleichen (HTML, PNG)
Beispiel:	/PLUGIN Webcam.Picture CAPTURE

Einstellungen:

[Webcam.Picture]

WebcamDeviceID Webcam-Geräte-ID Capture Webcam ist aktiviert beim Start? boolscher Wert CaptureTimeNormal Verzögerung zwischen Bilderfassung (ms) CaptureTimeIdle Verzögerung zwischen Bilderfassung wenn keine Anfrage gemacht wird (ms) Preview zeige Vorschaufenster an? boolscher Wert PreviewTransparency Transparenz des Vorschaufensters (Prozent) PreviewPosition Position des Vorschaufensters PreviewClickable Vorschaufenster kann angeklickt/verschoben/verändert werden? boolscher Wert LogoOffline Offline-Logo, Dateiname und Position, Position ist eines der folgenden: 0=mitte, 1=oben links, 2=oben rechts, 3=unten rechts, usw LogoOnline Online-Logo, Dateiname und Position LogoOnAir Onair-Logo, Dateiname und Position Width Bildbreite (Pixel) Height Bildhöhe (Pixel) Quality Qualität des JPEG-Bildes (Prozent) Brightness Bildhelligkeit (zwischen -100 und 100) Contrast Bildkontrast (zwischen 0 und 100) Grayscale Graustufen oder Farben? boolscher Wert Mirror spiegle Bild horizontal? boolscher Wert ServerHttpLocation Webserverort ServerHttpStreamName Streamname des Bildes

Das Webstatus-Plugin bietet zusätzliche Chatstatusinformationen als Liste mit Chatbenutzern im TEXT- oder XML-Format an. Wenn das Plugin installiert ist kann man darauf zugreifen unter http://127.0.0.1/chatstatus/userlist.txt oder http://myserver/chatstatus/userlist.txt (Standardeinstellungen). Bitte ersetze "myserver" mit der öffentlichen Adresse deines eigenen Servers.

Syntax:	/PLUGIN Web.Status STATUS
	/PLUGIN Web.Status RELOAD
Argumente:	STATUS = zeige kurzen Status an, Anzahl der Zugriffe RELOAD = lade Einstellungen neu

Einstellungen:	[Web.Status]
	TextFormatDefault Textformat, eines der folgenden: TEXT oder XML ServerHttpLocation Webserverort ServerHttpStreamName Streamname des Status

Das Winamp-Plugin zeigt das aktuelle Lied an, das im Winamp Mediaplayer gespielt wird.

Syntax:	/PLUGIN Winamp.Notify SHOW
	/PLUGIN Winamp.Notify AUTOMATIC
	/PLUGIN Winamp.Notify RELOAD
Argumente:	SHOW = zeige aktuellen Liedertitel an AUTOMATIC = schalte automatische Anzeige an/aus RELOAD = lade Einstellungen neu
Beispiel:	/PLUGIN Winamp.Notify SHOW

Einstellungen:	[Winamp.Notify]
	ChatCommand Chatbefehl zur Liederanzeige, Liedertitel wird angehängt TitleIgnore Liedertitel zum Ignorieren, Komma getrennte Liste Automatic automatische oder manuelle Liederanzeige? boolscher Wert StreamInfo zeige Stream-Informationen am Ende des Liedertitels an? boolscher Wert

Es gibt weitere Plugins die noch nicht veröffentlicht wurden und nur für Tester erhältlich sind. Hier testen wir neue Ideen und Funktionen. Beta-Plugins haben noch keine ausreichende Softwarequalität erreicht und brauchen wahrscheinlich mehr Zeit. Wir können nicht garantieren dass diese Plugins fehlerfrei funktionieren oder regelmäßig aktualisiert werden. Falls du interessierst bist, nimm Kontakt mit uns auf.

Hier eine Übersicht der vorhandenen Beta-Plugins:

• Plugin Annabot - Anna ist ein multifunktionaler Chatraum-Servicebot, sie hilft Chaträume und Chat-Communities zu verwalten
• Plugin Audio - Eine Voicechat-Erweiterung für den Chat. Das Plugin ist noch im Anfangsstadium und nur David weiss genau was es macht
• Plugin Register - Eine Webschnitstelle zur Benutzerverwaltung. Benutzer können sich registrieren, ihr Profil und Passwort ändern
• Plugin Skin - Ein Skinning-Plugin um die Windows-Benutzeroberfläche anzugleichen, mit neuen Grafiken und Hintergründen
• Plugin Talkbot - Der Talkbot ist ein experimenteller Bot der mit Benutzern sprechen kann und einfache Fragen beantwortet
• Plugin Whiteboard - Ein webbasiertes Whiteboard zum gemeinsamen Schreiben und Malen. Es unterstützt Farben und Bilder

Lade Plugins herunter und kopiere sie in das Pichat-Programm-Verzeichnis (dort wo deine pichat.exe ist), danach starte Pichat neu. Man kann installierte Plugins in den Chateinstellungen sehen oder mit dem /PLUGIN Befehl im Chat.

Es gibt eine INI-Datei welche alle persönlichen Plugin-Einstellungen speichert. Sie heißt "pichat_plugins.ini" und liegt im Pichat-Verzeichnis im Heimatverzeichnis. Bei Windows findet man sie dort wo Dokumente und Einstellungen gespeichert werden, %APPDATA% im Windows-Explorer eingeben. Ein Plugin muss mindestens einmal gestartet werden um seine Einstellungen zu erstellen. Manche Plugins beinhalten weitere Dateien zum Angleichen, man kann sie in ein Unterverzeichnis des Pichat-Verzeichnisses extrahieren.

Zum Deinstallieren reicht es aus Plugin-Dateien zu löschen. Falls du Hilfe brauchst oder Ideen für neue Funktionen hast, rede mit anderen Benutzern im Chat.