this is the main cwtch gui with the pretty interface https://cwtch.im
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.
Sarah Jamie Lewis 1337f97345 Merge pull request 'Add comboboxs to settings, minor tweaks' (#303) from dan/ui:combobox into master 5 days ago
android Android Back button like home button (#212) 9 months ago
assets Global Toolbar 1 month ago
go Add global settings pane; migrate peer settings to new opaque settings widgets; minor fixes; add global settings storage; rework global settings settings 1 week ago
i18n Add global settings pane; migrate peer settings to new opaque settings widgets; minor fixes; add global settings storage; rework global settings settings 1 week ago
linux install Desktop file for linux 9 months ago
qml adopt new opaque combobox; fix toolbar color on contactlist only pane; fix settings pane color to pane color 1 week ago
windows windows log to file 10 months ago
.drone.yml Fix assets loading in QML on windows 5 months ago
.gitignore migrate to stand alone log and connectivity packages 4 months ago
.gitmodules move widgets into the Opaque submodule project 1 month ago
LICENSE Add 'LICENSE' 1 year ago
Makefile assets folder + emoji drawer 5 months ago
README.md update README with git submodule instructions 1 month ago
get-therecipe-qt-dockers-imgs.sh get therecipe-qt-docker-imgs sh 3 months ago
go.mod Add global settings pane; migrate peer settings to new opaque settings widgets; minor fixes; add global settings storage; rework global settings settings 1 week ago
go.sum adding bottom status bar for global network status 1 month ago
main.go Add global settings pane; migrate peer settings to new opaque settings widgets; minor fixes; add global settings storage; rework global settings settings 1 week ago
qml.qrc Add global settings pane; migrate peer settings to new opaque settings widgets; minor fixes; add global settings storage; rework global settings settings 1 week ago
quality.sh move qmlfmt to serpeate standalone openprivacy repo 1 month ago
ui.pro assets folder + emoji drawer 5 months ago

README.md

Cwtch - UI

This codebase provides a graphical user interface for Desktop and Android for Cwtch: Privacy Preserving Infrastructure for Asynchronous, Decentralized and Metadata Resistant Applications

Security

Cwtch is an experimental concept and prototype. We do not recommend you use Cwtch today if you require secure communication. At least, not yet.

If you discover a security issue, please log an issue above, or email team@cwtch.im.

Running

Compiling

The UI is built using QT so you will need the development libraries and tools for your OS. Currently we are using QT 5.13.0

This code relies on therecipe/qt before getting started consult the Installation and Getting Started documentation to get that up and running. It will make building this much easier.

Cwtch UI uses the Go module system for dependancies, and git submodules for includin QML components

git submodule init
git submodule update

Linux

go mod vendor
qtdeploy build linux
./deploy/linux/ui -local -debug 2>&1 | grep -v 'Detected anchors on an item that is managed by a layout.'

The -debug flag increases the logging level.

The -local flag means the binary should use the local copies of QML files instead of the compiled ones allowing for more rapid UI development.

The grep statement filters out some QML noise.

Android

We supply an arm-pie version of tor in android/libs/armeabi-v7a with the name libtor.so

go mod vendor
qtdeploy -docker build android
adb install deploy/android/build-debug.apk

Windows

  • Download and install QT Open Source edition
  • Go to My Computer - Right Click on This PC - Advanced System Settings - Environment Variables
    • New - QT_DIR = C:\Qt (or wherever you have it installed)
    • New - QT_VERSION = 5.12.1 (because I picked 5.12.1)
    • Edit the Path Variable and Add C:\Qt\Tools\mingw530_32\bin
  • Install MSYS2 (Bash shell for windows)
  • Install Go and make sure it's in the PATH, and add your GOPATH/bin to the PATH
  • Setup therecipe/qt (instructions https://github.com/therecipe/qt/wiki/Installation-on-Windows)
    • go get -u -v github.com/therecipe/qt/cmd/...
    • qtsetup (Can take around an hour?)

If all that is done, then check out cwtch.im/ui

go mod vendor
qtdeploy
deploy/windows/ui

Currently if you do not have Tor running Cwtch will start tor for you, which will open a dos console window. We are working to hide this in the future.

Contributing

Translations

(If you'd like to add a new translation, feel free to open an issue and we can generate the .ts file for you to edit by hand, or in QT Linguist!)

Add new translation

  1. Install the language tools if you have not already (on linux: sudo apt-get install qttools5-dev qttools-dev-tools)

  2. Edit ui.pro and add a new line in the variable definition for TRANSLATIONS like:

    TRANSLATIONS = i18n/translation_en.ts
    i18n/translation_de.ts

  3. Edit qml.qrc and add a new line near the other translation files like:

    <file>i18n/translation_de.qm</file>

  4. To update and generate your new translation file, run lupdate ui.pro and you will find your new file in the i18n/ directory.

Updating translations

Run lupdate ui.pro to update all the translation files in the i18n/ directory, then edit your languages’ .ts file to make the appropriate changes. It is recommended to use QT Linguist (linguist) to edit the files.

When done, run lrelease ui.pro to compile all the translations from their .ts files into .qm files for use in the program. Then you can compile the ui program.