Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 1.63 KB

README.md

File metadata and controls

66 lines (42 loc) · 1.63 KB
Raw

TurboWarp Desktop

TurboWarp as a desktop app.

If you're looking for downloads, head to: https://desktop.turbowarp.org/

Licensed under the GPLv3.0. See LICENSE for more information.

Parts of this repository are based on LLK/scratch-desktop.

Building it yourself

Install these:

You'll need to open a terminal for the next steps.

Clone it:

git clone https://github.com/TurboWarp/desktop turbowarp-desktop
cd turbowarp-desktop

Install dependencies:

# This will take a while and it may seem to get stuck at some point. This is normal if your internet isn't the fastest.
npm ci

Download library files: (Optional, but if you don't do this then the libraries won't work)

npm run fetch

Build:

# Development
npm start

# Production (output is in `dist` folder)
npm run dist
# If it crashes with "JavaScript heap out of memory", try:
NODE_OPTIONS=--max-old-space-size=4096 npm run dist

Website

The website source code is in the docs folder.

Advanced customizations

TurboWarp Desktop lets you configure custom JS and CSS. This is an advanced feature that is not officially supported -- use at your own risk.

Find TurboWarp Desktop's data path:

  • Windows: %APPDATA%/TurboWarp
  • macOS: ~/Library/Application Support/TurboWarp
  • Linux (non-Snap): ~/.config/TurboWarp

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.