Archiver

Description

This set of modules are what constitutes Kosaka's extremely powerful archival system (alias in less fancy terms, its Message Logger).

🌲 Extended Modules → Archiver

Commands & More Details

Manager

All commands in this module follow the following authorization table:

Allowed Installs: ✔️ Guild Bot | ✖️ User Application

Allowed Places: ✔️ Guilds | ✖️ Kosaka DMs | ✖️ Private Channels

(Event Type):

- All | Every single Event Archived.

- Message | Every single Message-Type Events archived.

- Snipe | Every single Message-Type Events archived that have either been deleted or edited.

- Normal | Only Message-Type Events archived that have never been deleted or edited.

- Edited | Only Message-Type Events archived that have been edited.

- Deleted | Only Message-Type Events archived that have been deleted.

- System | Only System-Type Events such as interactions that have been archived.

@Kernel /archive dump (Event_Type: Event_Type = "All") — Uploads the JSON File containing all Events archived by Kosaka and filtered by (Event Type).

Quirk: The uploaded JSON is not identical to what is stored on TSN's Servers: it is normally Compressed and events are stored from Oldest Event to Newest.

@Kernel /archive delete — Wipes entirely the archive for the current channel.

@Kernel /archive nuke — Wipes entirely the archive for ALL channels inside the server.

Note: We recommend running this command AFTER disabling the Archiver, otherwise archives of the commands executed to disable the Archiver will remain.

@Root /archive view (Event_Type: Event_Type = "Snipe") — Initializes an interactive view which lets you visualize Archived Events.

• [←] | Advance 1 Event in the Future.
• [→] | Advance 1 Event in the Past.
• [↑] | Advance 1 Event History in the Future.
• [↓] | Advance 1 Event History in the Past.
• [👁️] | Displays the Event publicly.

Loggers

This module is in charge of automatically writing Events to the Archive.
The following Events are recorded:

• Executed Slash Commands
• New / Edited / Deleted Message
• New / Leaving / Banned / Updated Members
• Reactions (History not recorded) Message Archives are stored under Data/Archive/Messages/[Guild_ID]/[Channel_ID].cjson while User Archives at Data/Archive/Users/[User_ID].cjson as a 7z Compressed JSON file.
  You can disable the Archiver if you have Privacy Concerns using /settings_guild
  However please note this will not stop Kosaka from archiving the profiles of server members as they are required for certain functions.