You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

3.7 KiB

Cwtch UI

A Flutter based Cwtch UI.

This README covers build instructions, for information on Cwtch itself please go to


  • Android: Available from the Google Play Store (currently patrons only) or from as an APK
  • Windows: Available from as an installer or .zip file
  • Linux: Available from as a .tar.gz
    • installs the app into your home directory
    • as root to install system wide
    • or run out of the unziped directory


Cwtch processes the following environment variables:

  • CWTCH_HOME= overrides the default storage path of ~/.cwtch with what ever you choose
  • LOG_FILE= will reroute all of libcwtch-go's logging to the specified file instead of the console
  • LOG_LEVEL=debug will set the log level to debug instead of info


Getting Started

First you will need a valid flutter sdk installation and run flutter pub get to fetch dependencies.

You will probably want to disable Analytics on the Flutter Tool: flutter config --no-analytics

Building on Linux (for Linux)

  • run fetch-libcwtch-go.shlibCwtch-go to fetch a prebuild version of go to ./linux. Include ./linux in LD_LIBRARY_PATH
  • run and/or ensure that tor is in $PATH
  • run flutter run -d linux

Building on Windows (for Windows)

  • run fetch-libcwtch-go.ps1 to fetch a prebuild version of libCwtch.dll
  • run fetch-tor-win.ps1 to fetch Tor for windows
  • run flutter run -d windows

Building on Linux/Windows (for Android)

  • Follow the steps above to fetch libCwtch-go and tor (these will fetch Android versions of these binaries also)
  • run flutter run with an Android phone connect via USB (or some other valid debug mode)

Known Platform Issues

  • Windows: Flutter engine has a known bug around the Right Shift key being sticky. We have implemented a partial workaround, if this happens, tap left shift and it will reset.

l10n Instructions

Adding a new string

Strings are managed directly from our Lokalise(url?) project. Keys should be valid Dart variable names in lowerCamelCase. After adding a new key and providing/obtaining translations for it, follow the next step to update your local copy.

Updating translations

Only Open Privacy staff members can update translations.

In Lokalise, hit Download and make sure:

  • Format is set to "Flutter (.arb)
  • Output filename is set to l10n/intl_%LANG_ISO%.%FORMAT%
  • Empty translations is set to "Replace with base language"

Build, download and unzip the output, overwriting lib/l10n. The next time Flwtch is built, Flutter will notice the changes and update app_localizations.dart accordingly (thanks to generate:true in pubspec.yaml).

Adding a language

If a new language has been added to the Lokalise project, two additional manual steps need to be done:

  • Create a new key called localeXX for the name of the language
  • Add it to the settings pane by updating getLanguageFull() in lib/views/globalsettingsview.dart

Then rebuild as normal.

Using a string

Any widget underneath the main MaterialApp should be able to:

import 'package:flutter_gen/gen_l10n/app_localizations.dart';

and then use:



With generate: true in pubspec.yaml, the Flutter build process checks l10n.yaml for input/output filenames.