2021-12-09 11:14:14 +00:00
# OpenAsar
2021-12-11 18:02:08 +00:00
**An experimental open-source alternative of Discord desktop's `app.asar` **.
2021-12-09 11:25:01 +00:00
2021-12-11 18:02:08 +00:00
## Features
### :rocket: Speed: ~2x faster startup times (up to ~4x with experimental config)
### :feather: Lightweight: <2% of Discord's original size (9mb -> ~150kb)
### :electric_plug: Hotpluggable: Replace one file and it's installed, that's it
### :shield: No Tracking: Removes Discord's built-in tracking for crashes and errors
### :sewing_needle: Patching: A future platform for custom patches to further enhance
2021-12-09 11:50:16 +00:00
2021-12-11 18:02:08 +00:00
< br >
## To Be Implemented
Below is a list in order of priority, removed when completed:
2021-12-09 16:25:14 +00:00
- [ ] A bunch of specific minor fixes / features
2021-12-10 18:32:33 +00:00
- [ ] Add Discord-specific Electron flags?
2021-12-09 11:50:16 +00:00
- [ ] Auto start
2021-12-09 16:25:14 +00:00
- [ ] First run
2021-12-09 16:58:47 +00:00
- [ ] Self-write some small parts of internals
2021-12-09 18:30:07 +00:00
- [ ] Self-write updater code (currently mostly copied)
2021-12-09 22:29:16 +00:00
- [ ] Compatibility / replication of original Discord splash?
2021-12-11 18:02:08 +00:00
## Custom Patches / Changes
2021-12-09 22:29:52 +00:00
Custom patches are another main goal of OpenAsar, patching enhancements where otherwise impossible to do so with traditional mods. Our current ideas for patches to do:
2021-12-10 20:04:10 +00:00
- [X] Rewrite portions of Discord's code to not rely on external dependencies, increasing speed and decreasing size
2021-12-09 22:29:52 +00:00
- [X] Skipping checking for updates on startup
- [ ] Linux host app updating
2021-12-11 18:02:08 +00:00
< br >
2021-12-09 22:29:52 +00:00
## Install Guide
**OpenAsar is heavily disrecommened due to it being in early development.**
2021-12-11 11:39:05 +00:00
1. [Download latest nightly release ](https://github.com/GooseMod/OpenAsar/releases/download/nightly/app.asar )
2021-12-09 22:29:52 +00:00
4. Backup your original `app.asar` (rename to `app.asar.backup` / etc)
5. Install OpenAsar `app.asar` into the original path
2021-12-11 10:48:35 +00:00
**If using Linux it is highly recommended to disable write protection** (needing root to overwrite files) for your Discord install if you have it enabled. It is not much of a security defecit as Windows has no write protection as well. This enables updating the asar and potentially host updating further on.
2021-12-11 10:47:17 +00:00
2021-12-09 22:29:16 +00:00
## 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, they may temporarily brick your client until you revert your changes. The avaliable options are:
2021-12-11 09:59:39 +00:00
- `quickstart` (bool, default false) - whether to use Quickstart (experimental)
- `skipStartupUpdateChecks` (bool, default false) - skips startup update checking (Linux-only)
- `autoupdate` (bool, default true) - whether to autoupdate OpenAsar after Discord startup
2021-12-11 10:37:43 +00:00
- `multiInstance` (bool, default false) - whether to enable multi-instance
2021-12-09 22:29:16 +00:00
An example of a settings.json with OpenAsar config:
```json
{
"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
}
}
2021-12-11 08:13:27 +00:00
```
