No Description
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
noirscape bdadc250b1
Fix save_files
4 months ago
.gitignore Moved shared stuff between log and logexisting over to shared_funcs module 4 months ago
LICENSE To reduce log clutter, additional directories are now made for years and 8 months ago
README.md Save attachments, breaking change. Added discord invite to readme. 7 months ago
config.yaml.example Save attachments, breaking change. Added discord invite to readme. 7 months ago
log.py Moved shared stuff between log and logexisting over to shared_funcs module 4 months ago
logexisting.py Moved shared stuff between log and logexisting over to shared_funcs module 4 months ago
requirements.txt Moved shared stuff between log and logexisting over to shared_funcs module 4 months ago
run.py Negate log loading 8 months ago
shared_funcs.py Fix save_files 4 months ago

README.md

Panopticon

A user-focused message logger for Discord, a la the built-in logging present in many IRC clients.

Dependencies

  • Python 3.5 or greater
  • discord.py (rewrite branch)
  • pyyaml

Installation, setup, and usage

  • Clone the repo
  • Install the requirements pip install --user -r requirements.txt
  • Copy config.py.example to config.py and edit it
  • ./run.py

Attachment logging is possible, although it is disabled by default out of storage concerns. To turn it on, just flip change the setting in config.yaml . Attachment logging is done for both log.py and logexisting.py. Attachment logging may fail due to the attachment being deleted, this is logged to the console as a warning.

Modules

Panopticon comes with a module called logexisting.py. This module is not loaded in by default in the wrapper script for the very simple reason that it enables commands on the running account (if it is run under a user, this will function like a selfbot). If you desire to enable it, change the config file to enable it.

Enabling logexisting.py disables regular logging for that instance of panopticon for as long as it is on. This is to prevent interfering logs.

License

Panopticon is available under the terms of the BSD 3-clause license, which is located in this repository in the LICENSE file.

logexisting.py is licensed under the AGPLv3

Support

Invite

There’s a dedicated channel for panopticon in the above server plus a webhook that delivers notifications.

Breaking changes will also be announced in that server, so make sure to use it to stay up to date.

Credits and Thanks

  • Megumi Sonoda (GitHub, Twitter)
  • Rapptz for discord.py
  • ihaveamac for his fork of panopticon (GitHub, Twitter)
  • Cubebag (Discord user) for serverarchive.py, which helped for a starting point for logexisting.py