Settings

Description

This set of modules lets you manipulate and view the server-specific or your user-specific preferences.
When editing a JSON File, please note that they cannot contain comments, as such the comments (text that begin with "#") should not be included in the uploaded JSON file
The JSON file thus needs to be edited externally using a text editor such as Visual Studio Code, GNU/Nano, Notepad++, etc.

🌲 Core Modules → Settings

Commands & More Details

Guild

All commands in this module follow the following authorization table:

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

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

@Root /guild_settings dump — Uploads the JSON File containing the Server's Configuration file.

Here are the default values and description for each JSON Key and values:

{
	# Archiver Related Settings
	"Archiver": {
		"Allow_Archiving": true # [Bool] Should the Archiver be allowed to Archive any events inside the server? Set to "false" for privacy reasons.
	},

	# Random Message Related Settings
	"Random_Message": {
		"Allow_Caching": true # [Bool] Should Random Message allow to cache the messages that have been fetched? Set to "false" for privacy reasons, note this will make subsequent usage of the command significantly slower.
	},

	# Charm → Welcomer Related Settings
	"Welcomer": {
		# The Embed displayed when someone joins the Server
		"Welcome_Title": "\ud83d\udc4b  Welcome, ${User_Display}!",
		"Welcome_Description": "We hope you enjoy your stay in ${Guild_Name}!",
		# The Embed displayed when someone leaves the Server
		"Departure_Title": "\ud83e\udd40  ${User_Display} left the server.",
		"Departure_Description": "They stayed in the server for a grand total of ${Time_Present}."

		# For more information (notably about Placeholders), read more about the Welcomer Module at `https://github.com/Ascellayn/Kosaka_Issues/wiki/Charm#welcomer`.
	}
}

@Kernel /guild_settings load (File: File) — Upload a JSON File containing the Server's Configuration file to be applied to the Server.

See the information about /guild_settings dump for more information. Also don't try to be funny. Kosaka will get really mad if you fuck with the JSON file with malicious intent.

User

All commands in this module follow the following authorization table:

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

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

@Root /user_settings dump — Uploads the JSON File containing your Kosaka User Configuration.

Here are the default values and description for each JSON Key and values:

{
	# Archiver Related Settings
	"Archiver": {
		"Allow_Archiving": true # [Bool] Should the Archiver be allowed to Archive your User Profile History? Set to "false" for privacy reasons.
	},

	# Broadcast Related Settings
	"Broadcast": {
		"Allow_DM_Broadcasts": true # [Bool] Should we let Kosaka DM you (if you are the Server Owner of which Kosaka is in) when an important message related to Kosaka is sent?
	},

	# Changelog Related Settings
	"Changelog": {
		"Allow_DM_Announcements": true # [Bool] Should we let Kosaka DM you (if you are the Server Owner of which Kosaka is in) when an update occurs?
	}
}

@Kernel /user_settings load (File: File) — Upload a JSON File containing your Kosaka User Configuration file to be applied.

See the information about /user_settings dump for more information. Also don't try to be funny. Kosaka will get really mad if you fuck with the JSON file with malicious intent.