profxadke/OpenAsar
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Open-source alternative of Discord desktop's app.asar
358 commits 3 branches 1 tag 32 MiB
JavaScript 99.3%
Shell 0.6%
Find a file
Oj 02b393b86e [Scripts > Strip] Initial Add (not in use)
2022-02-03 22:57:50 +00:00
.github/workflows [CI > Build] Revert purposeful breakage to test 2022-02-02 20:13:41 +00:00
polyfills [Poly > Mkdirp] Cleanup a bit 2022-01-29 10:12:24 +00:00
scripts [Scripts > Strip] Initial Add (not in use) 2022-02-03 22:57:50 +00:00
src [Updater > Request] Clean up source further 2022-02-03 22:19:01 +00:00
.gitignore [Gitignore] Add miniSrc for minifying script 2022-01-31 09:13:05 +00:00
faq.md [FAQ] Add snappier info, reorder some 2021-12-21 23:11:47 +00:00
LICENSE Initial commit 2021-12-09 11:14:14 +00:00
README.md [Splash] Disable splashText by default 2022-01-30 20:33:37 +00:00
roadmap.md [Roadmap] Redo to use milestones instead of versions, add 2 and 3 2022-01-15 13:56:05 +00:00

README.md

OpenAsar

An experimental open-source alternative of Discord desktop's app.asar

Features

  • 🚀 Startup Speed: ~2x faster startup times (up to ~4x with experimental config)
  • 📈 Performance: OpenAsar can make your client feel snappier (scrolling, switching channels, etc)
  • 🖌️ Splash Theming: Easy theming for your splash which works with most themes for any client mod
  • 🔌 Hotpluggable: Replace one file and it's installed, that's it (same with uninstall)
  • ⚙️ Configurable: Adds many config options for Discord and OpenAsar enhancements (see config section)
  • 🪶 Lightweight: <2% of Discord's original size (9mb -> ~105kb)
  • 🛡️ No Tracking: Removes Discord's built-in tracking for crashes and errors in the asar (not app itself)

See FAQ for more details


Install Guide

Config

You can configure OpenAsar via settings.json (found in your Discord app data / user data), under a openasar object. Keep in mind most options are defaults for good reason.

OpenAsar Options

  • quickstart (bool, default false) - whether to use Quickstart (experimental)
  • themeSync (bool, default true) - syncs your modded client's theme with splash theming
  • autoupdate (bool, default true) - whether to autoupdate OpenAsar after Discord startup
  • updatePrompt (bool, default false) - whether to show update prompt after updating OpenAsar
  • splashText (bool, default false) - whether to show bottom right version info text in splash

Extra Discord Options

  • multiInstance (bool, default false) - whether to enable multi-instance
  • skipStartupUpdateChecks (bool, default false) - skips startup update checking (Linux-only)

An example of a settings.json with OpenAsar config:

{
  "BACKGROUND_COLOR": "#202225",
  "IS_MAXIMIZED": false,
  "IS_MINIMIZED": false,
  "WINDOW_BOUNDS": {
    "x": 801,
    "y": 22,
    "width": 797,
    "height": 876
  },
  "MINIMIZE_TO_TRAY": false,
  "OPEN_ON_STARTUP": false,
  "openasar": {
    "quickstart": true
  }
}

Additionally there are some environmental variables you can use:

  • OPENASAR_QUICKSTART (bool, default false) - same as quickstart config option
  • OPENASAR_NOSTART (bool, default false) - if enabled halts starting after splash loads (for splash testing)