ChatScribe

• Summary: Logs chats and commands
• Dependency Plugins: n/a
• PocketMine-MP 1.7dev-477 (3.0.0-ALPHA10)
• DependencyPlugins: -
• OptionalPlugins: -
• Categories: Admin
• Plugin Access: Commands, Data Saving
• WebSite: https://github.com/FienixEC/ChatScribeIC

Overview

NOTE:

This documentation was last updated for version 1.2.0.

Please go to github for the most up-to-date documentation.

You can also download this plugin from this page.

Let's you log all commands and chat's to files.

To ensure user's privacy, there is a set of regular expressions that will remove passwords before logging the line. You can add additional regular expressions if needed.

Usage:

• /log [on|off]
  • with no arguments shows logging status
  • on : enables logging
  • off : disables logging
• /spy [start|stop|ls] [player]
  • logs what a player is doing in-game. Useful to help noobs.

Users with the permission chatscribe.privacy do not have their commands logged.

The following command lines are modified before logging so passwords are NEVER stored:

• SimpleAuth related:
  • /login
  • /register
  • /unregister
• SimpleAuthHelper:
  • /chpwd

Configuration

Configuration is through the config.yml file. The following sections are defined:

main

• log: Either server or file
• dest: output destination. If log is file, this is a filename, otherwise emergency|alert|critical|error|warning|notice|info|debug
• default: If true, will start logging by default
• spy: Allow logging in-game
• privacy: regular expressions and replacements used for ensuring privacy
• warning: Text to show warning that logging is available

Permission Nodes

• chatscribe.cmd : Enable logging (Defaults to Op)
• chatscribe.privacy : No logging (Defaults to disabled)
• chatscribe.spy : Allow to spy on users in-game (Defaults to disabled)

Output Destinations

The dest setting in the config.yml file depends on the log log type.

If log set to server dest can be one of the following:

• emergency
• alert
• critical
• error
• warning
• notice
• info
• debug

Essentially this is included in the server.log and the lines will be tagged with that prefix. Whereas on the console, these different levels are color coded differently. The only special tag is debug. These are not show unless you enable debug logs in pocketmine.yml.

If log is set to file dest is set to a filename that will be created in the default PocketMine location (usually the same folder as server.log) but you can specify a full path if needed.

Changes

• 1.2.0: -Updated command script scode -Bumped API to 3.0.0-ALHA10

Copyright

ChatScribe
Copyright (C) 2015 Alejandro Liu
All Rights Reserved.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.