ClipCC as a standalone desktop application using tauri
See releases.
On Windows, you can use winget to install ClipCC.
winget install ClipTeam.ClipCC
For Arch Linux users, you can install the AUR package clipcc or clipcc-beta-bin:
yay -S clipcc
Or
yay -S clipcc-beta-bin
Note that these two packages conflict with each other.
Let's assume that you want to make a new release, version 3.999.0
, corresponding to clipcc-gui
version
0.1.0-prerelease.20yymmdd
.
- Merge
clipcc-gui
:cd clipcc-gui
git pull --all --tags
git checkout scratch-desktop
git merge 0.1.0-prerelease.20yymmdd
- Resolve conflicts if necessary
git tag scratch-desktop-v3.999.0
git push
git push --tags
- Prep
scratch-desktop
:cd scratch-desktop
git pull --all --tags
git checkout develop
npm install --save-dev 'clipcc-gui@github:clipteam/clipcc-gui#scratch-desktop-v3.999.0'
git add package.json package-lock.json
- Make sure the app works, the diffs look reasonable, etc.
git commit -m "bump clipcc-gui to scratch-desktop-v3.999.0"
npm version 3.999.0
git push
git push --tags
- Wait for the CI build and collect the release from the build artifacts
Eventually, the scratch-desktop
branch of the Scratch GUI repository will be merged with that repository's main
development line. For now, though, the scratch-desktop
branch holds a few changes that are necessary for the Scratch
app to function correctly but are not yet merged into the main development branch. If you only intend to build or work
on the scratch-desktop
repository then you can ignore this, but if you intend to work on clipcc-gui
as well, make
sure you use the scratch-desktop
branch there.
Previously it was necessary to explicitly build clipcc-gui
before building scratch-desktop
. This is no longer
necessary and the related build scripts, such as build-gui
, have been removed.
In the scratch-desktop
directory, run yarn fetch
. Re-run this any time you update clipcc-gui
or make any
other changes which might affect the media libraries.
First install all the develop dependencies by yarn
.
Then just run yarn tauri dev
and a dev server will be started and the tauri window will open.
Everything you coded can be hot reloaded.
Just run yarn tauri build
And then get the program at ./src-tauri/target/release/clipcc-desktop-tauri
(./src-tauri/target/release/clipcc-desktop-tauri.exe
for Windows) or the installer at ./src-tauri/target/release/bundle
Node that on macOS this will require installing various certificates.
This section is relevant only to members of the Scratch Team.
By default all Windows installers are unsigned. An APPX package for the Microsoft Store shouldn't be signed: it will be signed automatically as part of the store submission process. On the other hand, the non-Store NSIS installer should be signed.
To generate a signed NSIS installer:
- Acquire our latest digital signing certificate and save it on your computer as a
p12
file. - Set
WIN_CSC_LINK
to the path to your certificate file. For maximum compatibility I use forward slashes.- CMD:
set WIN_CSC_LINK=C:/Users/You/Somewhere/Certificate.p12
- PowerShell:
$env:WIN_CSC_LINK = "C:/Users/You/Somewhere/Certificate.p12"
- CMD:
- Set
WIN_CSC_KEY_PASSWORD
to the password string associated with your P12 file.- CMD:
set WIN_CSC_KEY_PASSWORD=superSecret
- PowerShell:
$env:WIN_CSC_KEY_PASSWORD = "superSecret"
- CMD:
- Build the NSIS installer only: building the APPX installer will fail if these environment variables are set.
npm run dist -- -w nsis
Sometimes the macOS build process will result in a build which crashes on startup. If this happens, check in Console
for an entry similar to this:
failed to parse entitlements for Scratch[12345]: OSUnserializeXML: syntax error near line 1
This appears to be an issue with codesign
itself. Rebooting your computer and trying to build again might help. Yes,
really.
See this issue for more detail: electron/osx-sign#218
After installed all the develop dependencies by yarn
, run yarn tauri dev
to start webpack develop server and tauri application. You can use DevTool by F12 or right click and select inspect
.
This application includes a telemetry system which is only active if the user opts in. When testing this system, it's
sometimes helpful to reset it by deleting the telemetry.json
file.
The location of this file depends on your operating system and whether or not you're running a packaged build. Running
from npm start
or equivalent is a non-packaged build.
In addition, macOS may store the file in one of two places depending on the OS version and a few other variables. If in doubt, I recommend removing both.
- Windows, packaged build:
%APPDATA%\Scratch\telemetry.json
- Windows, non-packaged:
%APPDATA%\Electron\telemetry.json
- macOS, packaged build:
~/Library/Application Support/Scratch/telemetry.json
or~/Library/Containers/edu.mit.scratch.scratch-desktop/Data/Library/Application Support/Scratch/telemetry.json
- macOS, non-packaged build:
~/Library/Application Support/Electron/telemetry.json
or~/Library/Containers/edu.mit.scratch.scratch-desktop/Data/Library/Application Support/Electron/telemetry.json
Deleting this file will:
- Remove any pending telemetry packets
- Reset the opt in/out state: the app should display the opt in/out modal on next launch
- Remove the random client UUID: the app will generate a new one on next launch