Skip to content
This repository has been archived by the owner on Feb 8, 2024. It is now read-only.
/ nucleus Public archive

Open-source reimplementation of @discord's desktop bootstrapper; feature-rich fork of OpenAsar.

License

Notifications You must be signed in to change notification settings

steviegt6/nucleus

Repository files navigation

Warning

nucleus has been archived, please see steviegt6/caesar.

nucleus Nightly Status License

Open-source reimplementation of Discord's Desktop app bootstraper (referred to by many as the app.asar).


What is nucleus?

nucleus is a reimplementation of the bootstrapper used by Desktop distributions of Discord. This is an alternative method of modding Discord through somewhat disconnected means.

nucleus Features

nucleus aims to be a feature-rich OpenAsar fork, and includes:

  • 🏠 shelter injection: comes packaged with the ability to inject uwu/shelter;
  • 📝 built-in settings file editing: adds the ability to directly edit your settings.json file for one reason or another.

nucleus Roadmap

Want to see future plans? View the roadmap.

OpenAsar Features

nucleus has all of OpenAsar's features, such as:

  • 🚀 faster start-up speeds: upwards of 2x-4x increases observed;
  • 📈 increased performance: increased speeds result in a snappier client;
  • 🖌️ start-up splash theming: easy theming for your start-up splash compatible with client mods;
  • 🔌 drop-in installation: all you need to do is change a file (uninstalling is the same);
  • ⚙️ configurable features: options to enhance both Discord and nucleus (see: Configuration);
  • 🪶 lightweight file size: about <2% of Discord's original size (9mb -> ~50kb);
  • 🛡️ reduced tracking: removes Discord's built-in tracking for crashes and errors in the bootstrapper (not app itself).

See the FAQ for more details!

Obtaining a Copy

Users

Users should download the latest release binary. See how by following the installation guide.

Developers

# clone the repo
git clone https://github.com/steviegt6/nucleus.git

# move into the newly-created directory
cd nucleus

# install dependencies
npm i

# if you just want to build
tsc
npm run pack

# if you want to build and run
# the dev script just runs tsc, scripts/pack.js, scripts/copy.js, and scripts/run.js
npm run dev

Configuration

You may configure nucleus by clicking the text that displays "nucleus" followed by a six-letter commit SHA in the bottom of your settings sidebar, which will open the config window.