OpenAsar/README.md

36 lines
1.6 KiB
Markdown
Raw Normal View History

2021-12-09 11:14:14 +00:00
# OpenAsar
**Open-source alternative of Discord desktop's `app.asar`** OpenAsar is currently made of **~80% own code**, with the rest being from Discord as it hasn't been rewritten yet or because of compatibility reasons.
2021-12-09 11:25:01 +00:00
## Goals
- **Hotpluggable** - just swap the asar file, nothing else needed
- **Lightweight** - it should be at least as fast or lightweight, hopefully more
2021-12-09 19:25:40 +00:00
- **No Tracking** - no crash reporting or error tracking (in normal Discord)
2021-12-09 11:50:16 +00:00
- **Minimal** - generally only doing what is needed (see: implementation)
2021-12-09 18:30:07 +00:00
- **Patch Platform** - provide a platform for future patching
2021-12-09 11:50:16 +00:00
## Implementation
Below is a list in order of priority, marked as complete when finished:
2021-12-09 16:25:14 +00:00
- [X] Bootstrapping
- [X] Splash screen
- [X] Error handling
- [ ] A bunch of specific minor fixes / features
- [ ] Handle hardware acceleration
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
- [ ] Patch updater to survive host updates
- [ ] Self-write updater code (currently mostly copied)
## Custom Patches
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:
- [ ] Skipping checking for updates on startup
- [ ] Linux host app updating
2021-12-09 16:58:47 +00:00
## Install Guide
**OpenAsar is heavily disrecommened due to it being in early development.**
1. Clone repo
2. NPM install in `src` dir (`cd src; npm i`)
3. Pack into `app.asar` via `asar` NPM package - `asar pack src app.asar`
4. Backup your original `app.asar` (rename to `app.asar.backup` / etc)
5. Install OpenAsar `app.asar` into the original path