diff --git a/logs/chat/README.md b/logs/chat/README.md new file mode 100644 index 0000000000..2171171817 --- /dev/null +++ b/logs/chat/README.md @@ -0,0 +1 @@ +Logs of chat rooms are stored in this directory if `logchat` is enabled. diff --git a/logs/logging.md b/logs/logging.md new file mode 100644 index 0000000000..490fe4e995 --- /dev/null +++ b/logs/logging.md @@ -0,0 +1,22 @@ +Pokémon Showdown Logging +======================================================================== + +This is the Pokémon Showdown log directory. + +Pokémon Showdown will, by default, log rated battles in each format, but not unrated +battles. To enable logging of unrated battles, turn on the config setting `logchallenges`. +There is currently no config option to disable logs for rated battles. +Battle logs are placed under a subdirectory for each month (e.g. `2013-02`). + +Moderator actions are logged in the subdirectory `modlog`. +Each chat room has a separate log file (e.g. `modlog_lobby.txt`). +Battle rooms share a single log file, which is named `modlog_battle.txt`. + +If the server or the simulator process crashes, a stack trace will +usually be logged to `errors.txt`. + +By default, Pokémon Showdown does not log chat rooms. However, you can +enable their logging by setting the `logchat` option in `config.js`. +If you enable it, the logs are written in the subdirectory named `chat`. +Each room gets their own subdirectory within, which are furthermore classified by month. + diff --git a/logs/modlog/README.md b/logs/modlog/README.md new file mode 100644 index 0000000000..6fe5d428f9 --- /dev/null +++ b/logs/modlog/README.md @@ -0,0 +1 @@ +Logs of moderation actions are stored in this directory. diff --git a/logs/repl/README.md b/logs/repl/README.md new file mode 100644 index 0000000000..cdd04b8ebd --- /dev/null +++ b/logs/repl/README.md @@ -0,0 +1,9 @@ +# repl directory + +The REPL feature is enabled by default; it can be disabled in `config.js`. + +This directory is used by default to store the REPL sockets to all of showdown's processes. + +The intended uses of these REPL sockets are for debugging (especially when the server is seemingly frozen) and scripting. + +You can use any tool capable of talking to Unix sockets such as `nc`. e.g. `nc -U app`, replacing `app` with the name of any socket in this directory. diff --git a/logs/tickets/README.md b/logs/tickets/README.md new file mode 100644 index 0000000000..0af72c3890 --- /dev/null +++ b/logs/tickets/README.md @@ -0,0 +1 @@ +Logs of ticket stats are stored in this directory.