Skip to content

Latest commit

 

History

History
389 lines (312 loc) · 15.1 KB

README.md

File metadata and controls

389 lines (312 loc) · 15.1 KB
Raw


Dorion

Dorion is an alternative Discord client aimed towards lower-spec or storage-sensitive PCs that supports themes, plugins, and more!
https://discord.gg/agQ9mRdHMZ

Download
View bleeding-edge builds

Bleeding Edge Builds

These builds are based on the latest GitHub Actions artifacts. They may not work properly, and they probably contain bugs. Use at your own risk!

Tip

Dorion can also be used portably or installed via several package managers. You can find these builds in the releases page. You can also build Dorion yourself!

Note

MacOS Users: If opening Dorion gives you "Dorion.app is damaged and cannot be opened", MacOS is lying to you and you may just need to run sudo xattr -rd com.apple.quarantine /Applications/Dorion.app. Alternatively, you can open the Privacy & Security settings pane and scroll down to the Security section to remove the quarantine.

Windows Users: Defender may think Dorion is a virus. This just happens sometimes, and if SmartScreen blocks it from running, click "More Info" and "Run Anyways". Feel free to scan Dorion with Virustotal!

Table of Contents

Package Repositories

I do not maintain any instances of Dorion in any package repositories myself, however some very kind people maintain some in their own spare time:

  • Windows:
    • Shovel/Scoop (Maintained by Small-Ku): 
      scoop bucket add turbo 'https://github.com/Small-Ku/turbo-bucket.git'
scoop install turbo/dorion
    • WinGet (Maintained by headquarter8302) 
      winget install --id SpikeHD.Dorion
  • Linux:
    • Arch AUR (Maintained by Refined7075) 
      yay -S dorion-bin
    • NixOS 
      nix-shell -p dorion
  • MacOS:
    • Homebrew (Maintained by psharma04) 
      brew tap psharma04/dorion
brew install --cask dorion

Note

Maintaining Dorion in a different package repository that I don't know about? Feel free to open a PR to add it here!

Features

  • Significantly smaller than the original Discord client, as well as other web-based alternatives
  • Theme support
  • Shelter and (optionally) Vencord/Equicord included out of the box
  • Full RPC/game presence support included out of the box. Enable it in "Performance & Extras"!
  • Feature flags for picking and choosing features (when building from source)
  • (Hopefully) better low-end system performance.
  • ARM support for ALL platforms

Plugins

Dorion comes with shelter, so that should cover at least some plugin-related needs. You can also enable client mods like Vencord inside the Dorion settings page. If you want to install plugins not available within the Dorion settings page, ensure you are downloading a browser-compatible version.

Note

Want official support for another client mod? As long as it works on the web, feel free to submit a feature request!

Themes

Dorion supports all themes, BetterDiscord and others, with a couple caveats.

Jump to "Using Plugins and Themes"

Platform Support

Feature Windows 10/11 Windows 7[1] Linux MacOS
Basics (logging in, navigation, text/DMs etc.) ✓ ✓ ~[2] ✓
Voice ✓ ✓ ✗[3] ✓
Themes ✓ ✓ ✓ ✓
Shelter ✓ ✓ ✓ ✓
Dorion Plugins ✓ ✓ ✓ ✓

1 While I am told it works fine, Windows 7 support is speculative and not guaranteed. It could break at any point, and if this happens, I probably won't put much effort into fixing it (PRs always welcome of course!). You may also need to manually install WebView2 if Dorion doesn't open after installing!

2 Some people report Dorion freezing on Linux, particularly when GIFs are playing. This is a bug in WebkitGTK.

3 Support for WebRTC is hidden behind a build-time flag that is not used in almost every distro. This will be available when WebkitGTK ships with WebRTC support, or if you compile your own WebkitGTK.

Building

Prerequisites

Steps

  1. Clone/download the repository

  2. Open a terminal window in the root project folder

  3. Install JS dependencies:

    pnpm install

  4. Pull the latest shelter build (this is used as a backup if it cannot be fetched on the fly)

    pnpm shupdate

  5. Apply the patches

    cd src-tauri
cargo patch-crate

  6. Build the updater

    pnpm build:updater

  7. (Linux-only) Build the WebKitGTK extension

    cd src-tauri/extension_webkit
cmake .
cmake --build .

  8. Build!

    # Build Dorion...
pnpm tauri build

# ...or to debug/open in dev mode
pnpm dev

All built files will be in src-tauri/target/(release|debug)/. Installation files (eg. .msi, .deb) are located in bundle/.

Known Issues

  • (non-Windows) External images (UserBG, Decor, UserPFP, etc.) will not load
  • (non-Windows) Fonts/font-faces will not load

Troubleshooting

  • "Oops! Something went wrong." (or a similar client crash)
    • Disable non-vital client mods/plugins/extensions and try again.
    • If you cannot get to the settings menu, you can delete the following items:
      • Windows: %appdata%\dorion\webdata & %appdata%\dorion\config.json
      • Linux: ~/.config/dorion/webdata & ~/.config/dorion/config.json
      • MacOS: ~/Library/Application Support/dorion/webdata & ~/Library/Application Support/dorion/config.json

Windows

  • Dorion not opening
    • Try installing via MSI instead of the .zip file
    • Try using the .zip file instead of the MSI
    • (If using the .zip file) make sure all files were extracted properly. Ensure you are extracting Dorion and it's contents into it's own folder.
    • Reinstall WebView2
      • Fully uninstall and reinstall.
      • If you are having trouble uninstalling it, or the installer says its already installed even though you uninstalled, try deleting this registry folder and uninstalling again Computer\HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Microsoft\EdgeUpdate\Clients\{F3017226-FE2A-4295-8BDF-00C3A9A7E4C5}

Linux

  • White/blank/frozen screen
    • Run Dorion with either, or both, of the following environment variables: 
      WEBKIT_DISABLE_COMPOSITING_MODE=1
WEBKIT_DISABLE_DMABUF_RENDERER=1

TODO

  • Pre-process fonts like images/CSS imports are already done
  • Multi-thread CSS processing
  • Use resource files from within the binary itself instead of the filesystem
  • Desktop notifications
    • AND displaying the number of notifs in the desktop icon
  • Webpack stuff
  • Global push-to-talk
  • Rich presence(?)
    • FULL rich presence
  • Custom keybinds
  • Helper API methods and events for plugins
  • Backup localized themes
  • Localization timeout
  • Safemode key (disable themes and plugins)
  • New release notifications
  • Logging system (like reMITM)
  • Move from device_query to rdev (supports more keys. May also just attempt to contribute to device_query)
  • API abstractions

Using Plugins, Extensions, and Themes

Tip

See the examples directory for examples of plugins, including how to include external code and themes.

Plugins, extensions, and themes are relatively simple to use, the file structure looks like so on Windows:

C:/Users/%USERNAME%/dorion/
    ├── plugins/
    |   └── plugin.js
    ├── extensions/
    |   └── some_unpacked_extension/
    └── themes/
        └── theme.css

and like so on Linux:

~/.config/dorion/
    ├── plugins/
    |   └── plugin.js
    └── themes/
        └── theme.css

so if you download a plugin, extension, or theme, just pop it into the plugins/extensions/themes folder. If you need help finding them, there are buttons in Dorion settings that'll take you where you need!

Note

Themes can also be installed by clicking Install Theme from Link in Theme settings, if you prefer

Contributing

Issues, PRs, etc. are all welcome! For guidelines and tips, see CONTRIBUTING.md

Contributors

Screenshots

Installer Size Comparison (Windows)

Full Installed Size Comparison (Windows)

Loading screen

Settings Menu

Theme: Catpuccin - Frappe

Theme: Fluent