OpenAsar/faq.md

# OpenAsar FAQ

### What is an asar?
An asar is a format for [Electron](https://electronjs.org), commonly used for the first part of apps as `app.asar`. Discord's `app.asar` includes various parts like:
- Updater
- Bootstrapping main part of the app
- Some crash and error reporting
- Splash screen

*OpenAsar* is an open-source alternative / rewrite / etc of Discord's `app.asar` which hopes to bring the various features outlined in the readme.

### Does OpenAsar support X mod?
Most likely, yes! OpenAsar is known to widely support BD, PC, GM, and others. It's very unlikely to cause any issues with your mods.

### This didn't speed up Discord that much for me?
If OpenAsar wasn't that much faster (in term of startup time) you likely already have a good PC. OpenAsar speeds up most for lower-end PCs, especially those without an SSD. You will likely still notice a subtle (~1.2x) difference.

### How does OpenAsar make the client "snappier" / more performant?
OpenAsar optimizes Chromium (the web engine / browser Discord uses) to help increase performance, mostly rendering, which looks like it helps makes most (~90%) people's clients looking noticeably snappier / faster generally. This is most noticeable with things like scrolling quickly, switching channels, and with various animations like tooltips for servers in the sidebar plus settings opening / closing.

### How is this so fast?
The main speed increase (default options) is mostly accidental / coincidental (not intended) as it is mostly a side effect of rewriting it.

### How is this so small?
Compared to Discord's original, OpenAsar is <2% of the size. This is because when rewriting we remove NPM dependencies with our own custom code for more performance and efficiency.

### What is Quickstart?
Quickstart "skips" a few Discord features like the splash screen and waiting for updates in favour of speed. It is currently experimental and not fully recommended for normal use.

### Is this 100% original?
No, and depends on your definition. By original if you mean all of this is rewritten, the vast majority (~90%) is self-rewritten or modified in some way. If you mean original by design, etc. - no, as we have to follow Discord APIs to maintain compatibility.

### Does this break ToS?
Most likely, as any slight modification to Discord at all counts as breaking it. You shouldn't really be that worried though, as there is very little history of anyone being banned just for modding.

### Can I use this in my project?
Sure! Just make sure to properly [respect the license](LICENSE) and clearly / transparently credit OpenAsar.

### Does OpenAsar update itself?
Yes, with a catch. On Windows it works out of the box, however on macOS or Linux you'll need to change the permissions for the entire resources folder for it to work.
[FAQ] Initial Add 2021-12-13 07:23:50 +00:00			`# OpenAsar FAQ`

			`### What is an asar?`
			An asar is a format for [Electron](https://electronjs.org), commonly used for the first part of apps as `app.asar`. Discord's `app.asar` includes various parts like:
			`- Updater`
			`- Bootstrapping main part of the app`
			`- Some crash and error reporting`
			`- Splash screen`

			OpenAsar is an open-source alternative / rewrite / etc of Discord's `app.asar` which hopes to bring the various features outlined in the readme.

[FAQ] Add snappier info, reorder some 2021-12-21 23:11:47 +00:00			`### Does OpenAsar support X mod?`
			`Most likely, yes! OpenAsar is known to widely support BD, PC, GM, and others. It's very unlikely to cause any issues with your mods.`

			`### This didn't speed up Discord that much for me?`
			`If OpenAsar wasn't that much faster (in term of startup time) you likely already have a good PC. OpenAsar speeds up most for lower-end PCs, especially those without an SSD. You will likely still notice a subtle (~1.2x) difference.`

			`### How does OpenAsar make the client "snappier" / more performant?`
			`OpenAsar optimizes Chromium (the web engine / browser Discord uses) to help increase performance, mostly rendering, which looks like it helps makes most (~90%) people's clients looking noticeably snappier / faster generally. This is most noticeable with things like scrolling quickly, switching channels, and with various animations like tooltips for servers in the sidebar plus settings opening / closing.`

[FAQ] Initial Add 2021-12-13 07:23:50 +00:00			`### How is this so fast?`
[FAQ] Add some more commonly asked questions 2021-12-19 21:18:06 +00:00			`The main speed increase (default options) is mostly accidental / coincidental (not intended) as it is mostly a side effect of rewriting it.`

			`### How is this so small?`
Remove Polyfills (#101) * poly: remove completely * bootstrap: remove unused request require * asarUpdate: rewrite request -> https * moduleUpdater: rewrite request -> https * ui: fallback to channel instead of "custom" if no hash * index: set name to branch for obvious testing * config/backend: tweak source * moduleUpdater: fix rewrite * moduleUpdater: fix rewrite (x2) * moduleUpdater: follow redirects with rewrite * ci: start multi-branch rewrite * ci: upgrade node to 18.x * ci: rewrite version changing to use existing * ci: change release version getting to in file * ci: mess with yaml syntax * ci: revert to node 16.x, fix version wrapped in quotes * ci: fix invalid yaml * ci: yaml syntax fixing * ci: append to tag * ci: make pre-release unless nightly build * ci: add title nicening * asarUpdate: fix release suffix * asarUpdate: fix not following redirect * winFirst: don't remake shortcuts, tweaks * ui: add channel prefix if non-nightly * chore: prep for main branch 2022-12-02 22:23:46 +00:00			`Compared to Discord's original, OpenAsar is <2% of the size. This is because when rewriting we remove NPM dependencies with our own custom code for more performance and efficiency.`
[FAQ] Initial Add 2021-12-13 07:23:50 +00:00
			`### What is Quickstart?`
[FAQ] Add snappier info, reorder some 2021-12-21 23:11:47 +00:00			`Quickstart "skips" a few Discord features like the splash screen and waiting for updates in favour of speed. It is currently experimental and not fully recommended for normal use.`
[FAQ] Add originality question 2021-12-13 11:06:15 +00:00
			`### Is this 100% original?`
[Docs] Update with latest info 2022-04-03 16:18:43 +00:00			`No, and depends on your definition. By original if you mean all of this is rewritten, the vast majority (~90%) is self-rewritten or modified in some way. If you mean original by design, etc. - no, as we have to follow Discord APIs to maintain compatibility.`

[FAQ] Add does this break ToS 2022-04-22 15:38:02 +00:00			`### Does this break ToS?`
			`Most likely, as any slight modification to Discord at all counts as breaking it. You shouldn't really be that worried though, as there is very little history of anyone being banned just for modding.`

[FAQ] Tweak 2022-04-05 18:58:06 +00:00			`### Can I use this in my project?`
[FAQ] Add does this break ToS 2022-04-22 15:38:02 +00:00			`Sure! Just make sure to properly [respect the license](LICENSE) and clearly / transparently credit OpenAsar.`
Add note about auto updating on Mac/Linux (#66) 2022-05-24 17:15:33 +00:00
			`### Does OpenAsar update itself?`
			`Yes, with a catch. On Windows it works out of the box, however on macOS or Linux you'll need to change the permissions for the entire resources folder for it to work.`