discord-protos 1.0.0

package/.github/workflows/update.yml

@@ -0,0 +1,30 @@
+name: update definitions
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: "0 0 * * *"
+
+jobs:
+  update:
+    runs-on: ubuntu-latest
+
+    permissions:
+      # Give the default GITHUB_TOKEN write permission to commit and push the changed files back to the repository.
+      contents: write
+
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        ref: ${{ github.head_ref }}
+    - uses: actions/setup-node@v3
+      with:
+        node-version: 18
+    - run: npm install
+    - run: npm run load
+    - run: npm run build
+    - run: npm run test
+
+    - uses: stefanzweifel/git-auto-commit-action@v4
+      with:
+        commit_message: Update protobuffer definitions

package/.prettierrc.yml

@@ -0,0 +1,3 @@
+trailingComma: "all"
+tabWidth: 4
+printWidth: 140

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-present dolfies
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,65 @@
+# Discord Protocol Buffers
+Reverse-engineering Discord's user settings protobufs.
+
+This repository provides protocol buffer files for Discord's user settings automatically generated and (soon™️) automatically updated. The protobufs are provided as .proto files in the out/ directory, one file per settings type.
+
+These protobufs are used by the Discord clients for user settings.
+
+Provided for educational purposes only.
+
+## Mapping
+The following table shows which protobuf user settings correspond to which .proto file.
+
+| Type  | Value                             | File                        | Use                                                |
+|-------|-----------------------------------|-----------------------------|----------------------------------------------------|
+| 1     | `PRELOADED_USER_SETTINGS`         | PreloadedUserSettings.proto | General Discord user settings.                     |
+| 2     | `FRECENCY_AND_FAVORITES_SETTINGS` | FrecencyUserSettings.proto  | Frecency and favorites storage for various things. |
+| 3     | `TEST_SETTINGS`                   | -                           | Unknown.                                           |
+
+## Usage
+### Note
+Automating user accounts is against the Discord ToS. This repository is a proof of concept and I cannot recommend using it. Do so at your own risk.
+
+### Installation
+```
+# with npm
+npm install discord-protos
+
+# with yarn
+yarn add discord-protos
+
+# with pnpm
+pnpm add discord-protos
+```
+
+### Example
+```js
+
+const DiscordProtos = require('discord-protos');
+
+const encoded = DiscordProtos.PreloadedUserSettings.toBase64({
+    status: {
+        status: {
+            value: "online",
+        },
+        custom_status: {
+            text: "hello world",
+        },
+    },
+});
+
+console.log("PreloadedUserSettings as base64", encoded);
+
+
+const decoded = DiscordProtos.PreloadedUserSettings.fromBase64(encoded);
+
+console.log("PreloadedUserSettings as json", encoded);
+```
+
+### Protobufs
+The .proto files can be compiled down to Python or JavaScript files by running `npm run py` or `npm run js`. This requires protoc to be installed.
+
+Base64-encoded data for these protobufs are provided by the `GET /users/@me/settings-proto/{type}` endpoint. For preloaded user settings, base64-encoded data is provided in the `USER_SETTINGS_PROTO` key of the READY event received in the Discord Gateway.
+
+### Development
+Running script in src/parse.js will print out the protocol buffers found. You need to define a `getModules()` function for it to work. That is on you.

package/out/FrecencyUserSettings.proto

@@ -0,0 +1,65 @@
+syntax = "proto3";
+
+package discord_protos.discord_users.v1.FrecencyUserSettings;
+
+message FrecencyUserSettings {
+  message Versions {
+    uint32 client_version = 1;
+    uint32 server_version = 2;
+    uint32 data_version = 3;
+  }
+
+  enum GIFType {
+    NONE = 0;
+    IMAGE = 1;
+    VIDEO = 2;
+  }
+
+  message FavoriteGIF {
+    GIFType format = 1;
+    string src = 2;
+    uint32 width = 3;
+    uint32 height = 4;
+    uint32 order = 5;
+  }
+
+  message FavoriteGIFs {
+    map<string, FavoriteGIF> gifs = 1;
+    bool hide_tooltip = 2;
+  }
+
+  message FavoriteStickers {
+    repeated fixed64 sticker_ids = 1;
+  }
+
+  message FrecencyItem {
+    uint32 total_uses = 1;
+    repeated uint64 recent_uses = 2;
+    int32 frecency = 3;
+    int32 score = 4;
+  }
+
+  message StickerFrecency {
+    map<fixed64, FrecencyItem> stickers = 1;
+  }
+
+  message FavoriteEmojis {
+    repeated string emojis = 1;
+  }
+
+  message EmojiFrecency {
+    map<string, FrecencyItem> emojis = 1;
+  }
+
+  message ApplicationCommandFrecency {
+    map<string, FrecencyItem> application_commands = 1;
+  }
+
+  optional Versions versions = 1;
+  optional FavoriteGIFs favorite_gifs = 2;
+  optional FavoriteStickers favorite_stickers = 3;
+  optional StickerFrecency sticker_frecency = 4;
+  optional FavoriteEmojis favorite_emojis = 5;
+  optional EmojiFrecency emoji_frecency = 6;
+  optional ApplicationCommandFrecency application_command_frecency = 7;
+}

package/out/PreloadedUserSettings.proto

@@ -0,0 +1,240 @@
+syntax = "proto3";
+
+import "google/protobuf/wrappers.proto";
+import "google/protobuf/timestamp.proto";
+
+package discord_protos.discord_users.v1.PreloadedUserSettings;
+
+message PreloadedUserSettings {
+  message Versions {
+    uint32 client_version = 1;
+    uint32 server_version = 2;
+    uint32 data_version = 3;
+  }
+
+  enum InboxTab {
+    UNSPECIFIED = 0;
+    MENTIONS = 1;
+    UNREADS = 2;
+    TODOS = 3;
+    FOR_YOU = 4;
+  }
+
+  message InboxSettings {
+    InboxTab current_tab = 1;
+    bool viewed_tutorial = 2;
+  }
+
+  message ChannelSettings {
+    bool collapsed_in_inbox = 1;
+  }
+
+  message GuildSettings {
+    map<fixed64, ChannelSettings> channels = 1;
+    uint32 hub_progress = 2;
+    uint32 guild_onboarding_progress = 3;
+    optional google.protobuf.Timestamp guild_recents_dismissed_at = 4;
+    bytes dismissed_guild_content = 5;
+  }
+
+  message AllGuildSettings {
+    map<fixed64, GuildSettings> guilds = 1;
+  }
+
+  message UserContentSettings {
+    bytes dismissed_contents = 1;
+    optional google.protobuf.StringValue last_dismissed_outbound_promotion_start_date = 2;
+    optional google.protobuf.Timestamp premium_tier_0_modal_dismissed_at = 3;
+  }
+
+  message VideoFilterBackgroundBlur {
+    bool use_blur = 1;
+  }
+
+  message VideoFilterAsset {
+    fixed64 id = 1;
+    string asset_hash = 2;
+  }
+
+  message SoundboardSettings {
+    float volume = 1;
+  }
+
+  message VoiceAndVideoSettings {
+    VideoFilterBackgroundBlur blur = 1;
+    uint32 preset_option = 2;
+    VideoFilterAsset custom_asset = 3;
+    optional google.protobuf.BoolValue always_preview_video = 5;
+    optional google.protobuf.UInt32Value afk_timeout = 6;
+    optional google.protobuf.BoolValue stream_notifications_enabled = 7;
+    optional google.protobuf.BoolValue native_phone_integration_enabled = 8;
+    optional SoundboardSettings soundboard_settings = 9;
+  }
+
+  message TextAndImagesSettings {
+    optional google.protobuf.StringValue diversity_surrogate = 1;
+    optional google.protobuf.BoolValue use_rich_chat_input = 2;
+    optional google.protobuf.BoolValue use_thread_sidebar = 3;
+    optional google.protobuf.StringValue render_spoilers = 4;
+    repeated string emoji_picker_collapsed_sections = 5;
+    repeated string sticker_picker_collapsed_sections = 6;
+    optional google.protobuf.BoolValue view_image_descriptions = 7;
+    optional google.protobuf.BoolValue show_command_suggestions = 8;
+    optional google.protobuf.BoolValue inline_attachment_media = 9;
+    optional google.protobuf.BoolValue inline_embed_media = 10;
+    optional google.protobuf.BoolValue gif_auto_play = 11;
+    optional google.protobuf.BoolValue render_embeds = 12;
+    optional google.protobuf.BoolValue render_reactions = 13;
+    optional google.protobuf.BoolValue animate_emoji = 14;
+    optional google.protobuf.UInt32Value animate_stickers = 15;
+    optional google.protobuf.BoolValue enable_tts_command = 16;
+    optional google.protobuf.BoolValue message_display_compact = 17;
+    optional google.protobuf.UInt32Value explicit_content_filter = 19;
+    optional google.protobuf.BoolValue view_nsfw_guilds = 20;
+    optional google.protobuf.BoolValue convert_emoticons = 21;
+    optional google.protobuf.BoolValue expression_suggestions_enabled = 22;
+    optional google.protobuf.BoolValue view_nsfw_commands = 23;
+    optional google.protobuf.BoolValue use_legacy_chat_input = 24;
+  }
+
+  message NotificationSettings {
+    optional google.protobuf.BoolValue show_in_app_notifications = 1;
+    optional google.protobuf.BoolValue notify_friends_on_go_live = 2;
+    fixed64 notification_center_acked_before_id = 3;
+  }
+
+  enum GuildActivityStatusRestrictionDefault {
+    OFF = 0;
+    ON_FOR_LARGE_GUILDS = 1;
+  }
+
+  message PrivacySettings {
+    optional google.protobuf.BoolValue allow_activity_party_privacy_friends = 1;
+    optional google.protobuf.BoolValue allow_activity_party_privacy_voice_channel = 2;
+    repeated fixed64 restricted_guild_ids = 3;
+    bool default_guilds_restricted = 4;
+    bool allow_accessibility_detection = 7;
+    optional google.protobuf.BoolValue detect_platform_accounts = 8;
+    optional google.protobuf.BoolValue passwordless = 9;
+    optional google.protobuf.BoolValue contact_sync_enabled = 10;
+    optional google.protobuf.UInt32Value friend_source_flags = 11;
+    optional google.protobuf.UInt32Value friend_discovery_flags = 12;
+    repeated fixed64 activity_restricted_guild_ids = 13;
+    GuildActivityStatusRestrictionDefault default_guilds_activity_restricted = 14;
+    repeated fixed64 activity_joining_restricted_guild_ids = 15;
+    repeated fixed64 message_request_restricted_guild_ids = 16;
+    optional google.protobuf.BoolValue default_message_request_restricted = 17;
+    optional google.protobuf.BoolValue drops_opted_out = 18;
+    optional google.protobuf.BoolValue non_spam_retraining_opt_in = 19;
+  }
+
+  message DebugSettings {
+    optional google.protobuf.BoolValue rtc_panel_show_voice_states = 1;
+  }
+
+  message GameLibrarySettings {
+    optional google.protobuf.BoolValue install_shortcut_desktop = 1;
+    optional google.protobuf.BoolValue install_shortcut_start_menu = 2;
+    optional google.protobuf.BoolValue disable_games_tab = 3;
+  }
+
+  message CustomStatus {
+    string text = 1;
+    fixed64 emoji_id = 2;
+    string emoji_name = 3;
+    fixed64 expires_at_ms = 4;
+  }
+
+  message StatusSettings {
+    optional google.protobuf.StringValue status = 1;
+    optional CustomStatus custom_status = 2;
+    optional google.protobuf.BoolValue show_current_game = 3;
+  }
+
+  message LocalizationSettings {
+    optional google.protobuf.StringValue locale = 1;
+    optional google.protobuf.Int32Value timezone_offset = 2;
+  }
+
+  enum Theme {
+    UNSET = 0;
+    DARK = 1;
+    LIGHT = 2;
+  }
+
+  message ClientThemeSettings {
+    optional google.protobuf.UInt64Value primary_color = 1;
+    optional google.protobuf.UInt32Value background_gradient_preset_id = 2;
+    optional google.protobuf.FloatValue background_gradient_angle = 3;
+  }
+
+  message AppearanceSettings {
+    Theme theme = 1;
+    bool developer_mode = 2;
+    optional ClientThemeSettings client_theme_settings = 3;
+    bool mobile_redesign_disabled = 4;
+  }
+
+  message GuildFolder {
+    repeated fixed64 guild_ids = 1;
+    optional google.protobuf.Int64Value id = 2;
+    optional google.protobuf.StringValue name = 3;
+    optional google.protobuf.UInt64Value color = 4;
+  }
+
+  message GuildFolders {
+    repeated GuildFolder folders = 1;
+    repeated fixed64 guild_positions = 2;
+  }
+
+  enum FavoriteChannelType {
+    UNSET_FAVORITE_CHANNEL_TYPE = 0;
+    REFERENCE_ORIGINAL = 1;
+    CATEGORY = 2;
+  }
+
+  message FavoriteChannel {
+    string nickname = 1;
+    FavoriteChannelType type = 2;
+    uint32 position = 3;
+    fixed64 parent_id = 4;
+  }
+
+  message Favorites {
+    map<fixed64, FavoriteChannel> favorite_channels = 1;
+    bool muted = 2;
+  }
+
+  message AudioContextSetting {
+    bool muted = 1;
+    float volume = 2;
+    fixed64 modified_at = 3;
+  }
+
+  message AudioSettings {
+    map<fixed64, AudioContextSetting> user = 1;
+    map<fixed64, AudioContextSetting> stream = 2;
+  }
+
+  message CommunitiesSettings {
+    optional google.protobuf.BoolValue disable_home_auto_nav = 1;
+  }
+
+  optional Versions versions = 1;
+  optional InboxSettings inbox = 2;
+  optional AllGuildSettings guilds = 3;
+  optional UserContentSettings user_content = 4;
+  optional VoiceAndVideoSettings voice_and_video = 5;
+  optional TextAndImagesSettings text_and_images = 6;
+  optional NotificationSettings notifications = 7;
+  optional PrivacySettings privacy = 8;
+  optional DebugSettings debug = 9;
+  optional GameLibrarySettings game_library = 10;
+  optional StatusSettings status = 11;
+  optional LocalizationSettings localization = 12;
+  optional AppearanceSettings appearance = 13;
+  optional GuildFolders guild_folders = 14;
+  optional Favorites favorites = 15;
+  optional AudioSettings audio_context_settings = 16;
+  optional CommunitiesSettings communities = 17;
+}

package/package.json

@@ -0,0 +1,32 @@
+{
+    "name": "discord-protos",
+    "version": "1.0.0",
+    "description": "A parser for Discord's protobufs",
+    "main": "src/index.js",
+    "packageManager": "pnpm@7.14.2",
+    "contributors": [
+        {
+            "name": "dolfies",
+            "email": "jeyalfie47@gmail.com",
+            "url": "https://github.com/dolfies"
+        },
+        {
+            "name": "Samuel Scheit",
+            "email": "github@samuelscheit.com",
+            "url": "https://samuelscheit.com"
+        }
+    ],
+    "license": "MIT",
+    "scripts": {
+        "build": "pbjs -t static-module --keep-case -w commonjs -o src/proto.js out/*.proto && pbts -o src/proto.d.ts src/proto.js",
+        "load": "node src/load.js",
+        "test": "node src/test.js"
+    },
+    "devDependencies": {
+        "protobufjs-cli": "^1.1.1",
+        "puppeteer": "^19.7.0"
+    },
+    "dependencies": {
+        "protobufjs": "^7.2.2"
+    }
+}

package/src/index.js

@@ -0,0 +1,51 @@
+const proto = require("./proto");
+
+function toBase64(data) {
+    return Buffer.from(this.encode(data).finish()).toString("base64");
+}
+
+function fromBase64(base64) {
+    return this.decode(Buffer.from(base64, "base64")).toJSON();
+}
+
+class PreloadedUserSettings extends proto.discord_protos.discord_users.v1.PreloadedUserSettings.PreloadedUserSettings {
+    /**
+     * @param {proto.discord_protos.discord_users.v1.PreloadedUserSettings.IPreloadedUserSettings} data
+     * @returns {string}
+     */
+    static toBase64(data) {
+        return toBase64.call(this, data);
+    }
+
+    /**
+     * @param {string} base64
+     * @returns {proto.discord_protos.discord_users.v1.PreloadedUserSettings.PreloadedUserSettings}
+     */
+    static fromBase64(base64) {
+        return fromBase64.call(this, base64);
+    }
+}
+
+class FrecencyUserSettings extends proto.discord_protos.discord_users.v1.FrecencyUserSettings.FrecencyUserSettings {
+    /**
+     * @param {proto.discord_protos.discord_users.v1.FrecencyUserSettings.IFrecencyUserSettings} data
+     * @returns {string}
+     */
+    static toBase64(data) {
+        return toBase64.call(this, data);
+    }
+
+    /**
+     * @param {string} base64
+     * @returns {proto.discord_protos.discord_users.v1.FrecencyUserSettings.FrecencyUserSettings}
+     */
+    static fromBase64(base64) {
+        return fromBase64.call(this, base64);
+    }
+}
+
+module.exports = {
+    PreloadedUserSettings,
+    FrecencyUserSettings,
+    ...proto.discord_protos,
+};

package/src/load.js

@@ -0,0 +1,26 @@
+const puppeteer = require("puppeteer");
+const fs = require("fs");
+const { join } = require("path");
+const script = fs.readFileSync(join(__dirname, "parse.js"), "utf8");
+
+async function main() {
+    const browser = await puppeteer.launch({
+        headless: true,
+    });
+
+    const page = await browser.newPage();
+    await page.goto("https://discord.com/app", { waitUntil: "networkidle0" });
+
+    const protos = await page.evaluate(`${script}; protos`);
+	
+    for (const [name, proto] of Object.entries(protos)) {
+        fs.writeFileSync(
+            join(__dirname, "..", "out", name + ".proto"),
+            proto.data,
+        );
+    }
+
+    await browser.close();
+}
+
+main();