Configuration

Config file

The planet can be configured through the file gryt.config.ts.

The config file is written in Typescript, meaning you will not be able to assign incompatible values. This results in more stability.

gryt.config.ts

type configType = {
  title: string;
  description: string;
  tags?: string[];
  url?: string;
  video_max_bitrate: number;
  voice_max_bitrate: number;
  file_max_size: number;
};

export const config: configType = {
  // General information
  title: "Dagobah",
  description: "One of the purest places in the galaxy within the Force",
  tags: ["Friendly", "Games", "DnD", "Bring a friend", "Star Wars"],
  url: "https://gryt-docs.vercel.app/",

  // Limitations
  video_max_bitrate: 6000,
  voice_max_bitrate: 320,
  file_max_size: 100,
};

Parameter explanation

General information

Name	Default	Description	Visible to the user
title	'Dagobah'	The name of the planet	Yes
description	'Some description'	The description of the planet	Yes
tags	['aTag', 'anotherTag']	Tags that describe the planet	Yes
url	'https://gryt.chat'	The planet's homepage	Yes

Limitations

Name	Default	Description	Visible to the user
video_max_bitrate	6000	Maximum video bitrate the planet transmits when streaming	No
voice_max_bitrate	320	Maximum audio bitrate the planet transmits when in a voice call	No
file_max_size	100	Maximum allowed file size for user uploads, measured in megabytes.	Situational