OpenAsar/README.md

28 lines
1.1 KiB
Markdown
Raw Normal View History

2021-12-09 11:14:14 +00:00
# OpenAsar
2021-12-09 11:53:03 +00:00
**Open-source alternative of Discord desktop's `app.asar`**
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 16:25:14 +00:00
- **No Tracking** - no crash reporting, error tracking, etc
2021-12-09 11:50:16 +00:00
- **Minimal** - generally only doing what is needed (see: implementation)
## 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
- [ ] Self-write updater code (currently mostly copied)
2021-12-09 16:58:47 +00:00
- [ ] Self-write some small parts of internals
## 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