|
1 | | -# TurboWarp Desktop |
| 1 | +# Where is PenguinMod Desktop? |
2 | 2 |
|
3 | | -TurboWarp as a desktop app. |
| 3 | +If you came to this repository expecting PenguinMod desktop and a download link, sorry! :( |
4 | 4 |
|
5 | | -If you're looking for downloads, head to: https://desktop.turbowarp.org/ |
| 5 | +We have not made a desktop app yet. This repository was just a fork of TurboWarp's desktop app that has NOT been edited to work with PenguinMod. |
6 | 6 |
|
7 | | -Licensed under the GPLv3.0. See LICENSE for more information. |
8 | | - |
9 | | -Parts of this repository are based on [LLK/scratch-desktop](https://github.com/LLK/scratch-desktop). |
10 | | - |
11 | | -## Building it yourself |
12 | | - |
13 | | -Install these: |
14 | | - |
15 | | - - [Git](https://git-scm.com/) |
16 | | - - [Node.js](https://nodejs.org/en/) |
17 | | - |
18 | | -You'll need to open a terminal for the next steps. |
19 | | - |
20 | | -Clone it: |
21 | | - |
22 | | -```bash |
23 | | -git clone https://github.com/TurboWarp/desktop turbowarp-desktop |
24 | | -cd turbowarp-desktop |
25 | | -``` |
26 | | - |
27 | | -Install dependencies after each update: |
28 | | - |
29 | | -```bash |
30 | | -# This will take a while. |
31 | | -npm ci |
32 | | -``` |
33 | | - |
34 | | -Download library files and packager HTML after each update: (Optional, but if you don't do this then some features may not work) |
35 | | - |
36 | | -``` |
37 | | -npm run fetch |
38 | | -``` |
39 | | - |
40 | | -Build: |
41 | | - |
42 | | -```bash |
43 | | -# Development |
44 | | -npm start |
45 | | - |
46 | | -# Production (output is in `dist` folder) |
47 | | -npm run dist |
48 | | -# If it crashes with "JavaScript heap out of memory", try: |
49 | | -NODE_OPTIONS=--max-old-space-size=4096 npm run dist |
50 | | -``` |
51 | | - |
52 | | -## Website |
53 | | - |
54 | | -The website source code is in the `docs` folder. |
55 | | - |
56 | | -## Advanced customizations |
57 | | - |
58 | | -TurboWarp Desktop lets you configure custom JS and CSS. |
59 | | - |
60 | | -Find TurboWarp Desktop's data path by using the list below or by clicking "?" in the top right corner, then "Desktop Settings", then "Open User Data Folder", then opening the highlighted folder. |
61 | | - |
62 | | - - Windows (except Microsoft Store): `%APPDATA%/turbowarp-desktop` |
63 | | - - Microsoft Store: Open `%LOCALAPPDATA%/Packages`, find the folder with the word `TurboWarpDesktop` in it, then open `LocalCache/Roaming/turbowarp-desktop` |
64 | | - - macOS: `~/Library/Application Support/turbowarp-desktop` |
65 | | - - Linux (except Snap, Flatpak): `~/.config/turbowarp-desktop` |
66 | | - - Linux (Snap): `~/snap/turbowarp-desktop/current/.config/turbowarp-desktop` |
67 | | - - Linux (Flatpak): `~/.var/app/org.turbowarp.TurboWarp/config/turbowarp-desktop` |
68 | | - |
69 | | -Create the file `userscript.js` in this folder to configure custom JS. Create the file `userstyle.css` in this folder to configure custom CSS. Completely restart TurboWarp Desktop (including all windows) to apply. |
70 | | - |
71 | | -## Update checker |
72 | | - |
73 | | -TurboWarp Desktop includes a simple update checker. This update checker is disabled by default on local builds. To manally enable it, set the `TW_ENABLE_UPDATE_CHECKER` environment variable to `1` at build-time. In builds with the update checker enabled, the checker can be disabled through the "(?) > Desktop Settings" menu or by setting the `TW_DISABLE_UPDATE_CHECKER` environment variable to `1` at runtime. |
74 | | - |
75 | | -## Uninstall |
76 | | - |
77 | | -See https://desktop.turbowarp.org/uninstall |
78 | | -hi |
| 7 | +Please be patient with us. We'll provide links to our real desktop project here once possible. |
0 commit comments