diff --git a/README.md b/README.md index e983207..6f2d846 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ - **Hotpluggable** - just swap the asar file, nothing else needed - **Lightweight** - it should be at least as fast or lightweight, hopefully more - **No Tracking** - no crash reporting or error tracking (in normal Discord) -- **Minimal** - generally only doing what is needed (see: implementation) +- **Minimal** - generally only doing what is needed - **Patch Platform** - provide a platform for future patching ## Implementation @@ -20,10 +20,37 @@ Below is a list in order of priority, marked as complete when finished: - [ ] Self-write some small parts of internals - [ ] Patch updater to survive host updates - [ ] Self-write updater code (currently mostly copied) +- [ ] Compatibility / replication of original Discord splash? + +## 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: +- `quickstart` (bool) - enables Quickstart (experimental) +- `skipStartupUpdateChecks` (bool) - skips startup update checking (Linux-only) + +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 + } +} +``` + ## 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 +- [X] Skipping checking for updates on startup - [ ] Linux host app updating