> ## Documentation Index
> Fetch the complete documentation index at: https://docs.doglytdc.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# doglytdc.json

> All fields in the script's data file.

`doglytdc.json` lives at the root and stores the script's data. It is created along with the script.

## Example

```json theme={null}
{
  "name": "Meu Script",
  "description": "Exemplo de script",
  "category": "tampermonkey",
  "platforms": [],
  "access": "free",
  "protection": true,
  "logo": null,
  "entry": "src/script.js",
  "version": "0.1.0"
}
```

## Fields

**name** `string` *required*

Script name (1 to 120 characters).

**description** `string`

Short description. Empty when not provided.

**category** `string` *required*

Script type. One of: `bookmark`, `tampermonkey`, `extension`, `terminal`, `app`, `discord_bot`.

**platforms** `string[]`

Only for `app`: `windows`, `linux`, `android`, `ios`. For other types, it is `[]`.

**access** `string` *required*

Who can use it: `free` (free), `paid` (paid), or `private` (private).

**protection** `boolean` *required*

Delivery protection. When enabled (default), the package is delivered only encrypted and only to those with access. When disabled, publishing requires confirmation (`confirm_unprotected`).

**logo** `string | null`

Logo's `https` URL, or `null`.

**entry** `string` *required*

Entry file. Always `src/script.js`.

**version** `string` *required*

Initial template version: `0.1.0`.

## Script types

| `category` | Name | Where it runs | Limitations |
| - | - | - | - |
| `bookmark` | Bookmark/Console | Browser bookmark or pasted into the console (F12). | Sites with strict CSP may block it; does not run automatically when the page opens. |
| `tampermonkey` | Tampermonkey | Userscript in Tampermonkey/Violentmonkey; runs automatically on @match sites. | Requires the extension to be installed; GM\_\* only with @grant. |
| `extension` | Extension | Chrome/Edge extension (Manifest V3). | No remote code or eval; installation is unpacked or through the store. |
| `terminal` | Terminal | Terminal command (bash/PowerShell). | Runs with the executing user's permissions; no card on the page. |
| `app` | App | Downloadable application: Windows, Linux, Android, or iOS. | Each platform has its own package; iOS requires Apple signing. |
| `discord_bot` | Discord bot | Bot hosted on DoglyTdc: / commands, selectors, buttons, and forms in your server. | Responds to commands, selectors, and buttons; does not continuously read all chat messages. Requires an application in the Discord Developer Portal. |

## Tampermonkey header

For the `tampermonkey` type, `src/script.js` starts with the userscript header:

```js theme={null}
// ==UserScript==
// @name         Meu Script
// @version      0.1.0
// @match        *://*/*
// @grant        none
// ==/UserScript==
```

Change `@match` to the sites where the script should run and use `@grant` if you need `GM_*` functions.

> [!NOTE]
>
> The version number users receive is the **published version** (for example `1.2.0`), not the `version` field in this file.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.