search

IBBoard / cawbird

A fork of the Corebird GTK Twitter client that continues to work with Twitter
https://ibboard.co.uk/cawbird/
GNU General Public License v3.0
309 stars 37 forks source link
gtk3 hacktoberfest social twitter vala

readme

Cawbird 1.5

DEPRECATION NOTICE

⚠ As of January 2023, Cawbird for Twitter is no longer being developed ⚠

This is because Twitter changed the Developer Agreement to prohibit "creating a substitute for Twitter Applications" and revoked our primary API keys around 20th January.

The next generation of Cawbird will be a Mastodon client. Follow Cawbird Toot Point Oh (codename NewCaw) at https://github.com/CodedOre/NewCaw

Introduction

Cawbird is was a fork of the Corebird Twitter client from Baedert, which became unsupported after Twitter disabled the streaming API.

Cawbird works worked with the new APIs and includes a few fixes and modifications that have historically been patched in to IBBoard's custom Corebird build on his personal Open Build Service account1.

Packaging and installation

Cawbird packages are built in the Cawbird Open Build Service project. They can be installed from the Cawbird download page.

Install Cawbird

These packages are currently available for:

i586, x86_64 (amd64), aarch64 (arm64) and armv7l are available on most platforms (where supported by the distro).

Official distro repositories

The following distros currently have their own official packages:

Community builds

Dependencies

Twitter uses specific codecs for videos. These are provided by libav and are not included in the core repositories of many distros. The following additional repositories are known to include the required libraries:

Shortcuts

Key Description
Ctrl + t Compose Tweet
Back Go one page back (this can be triggered via the back button on the keyboard, the back thumb button on the mouse or Alt + Left)
Forward Go one page forward (this can be triggered via the forward button on the keyboard, the forward thumb button on the mouse or Alt + Right)
Alt + num Go to page num (between 1 and 7 at the moment)
Ctrl + Shift + s Show/Hide topbar
Ctrl + p Show account settings
Ctrl + k Show account list
Ctrl + Shift + p Show application settings

When a tweet is focused (via keynav):

Limitations

Due to changes in the Twitter API, Cawbird has the following limitations:

All limitations are limitations imposed by Twitter and are not the fault of the Cawbird client. They have affected all third-party client applications.

Cawbird has also been unable to implement the following features because Twitter did not provide a way for third-party applications to get the data:

As of July 2020, Twitter has announced v2 of the API and may support some of these features. We are looking in to this as that parts of the API are made available.

Known issues

There are no current known issues with running Cawbird.

Previously, the following issues have occurred that were outside of our control:

Translations

Since February 2020, there has been a Cawbird project on Transifex. Users can sign up on Transifex for free to help translate Cawbird.

Testing

Since August 2020, there has been a Cawbird "unstable" package built on the Open Build Service. These packages are intended for users who can't build Cawbird from source but want to test new features.

Do not use the unstable release unless you are testing new features and understand the risks. They are not intended for everyday use. They will be updated intermittently with new features from git master. They may have bugs. They may not get patched. They may be behind the main release. They may break things and eat your homework.

It is recommended that you backup ~/.config/cawbird before running Cawbird-Unstable.

Contributing

All contributions are welcome (artwork, design, code, just ideas, etc.) but if you're planning to actively change something bigger, talk to me first.

Compiling Cawbird

Preparation

Twitter clients need keys and secrets so that Twitter can go through the OAuth process. Cawbird used to ship with a standard set of but has always supported custom keys through schema settings. However, that wasn't convenient for software builds. Cawbird now supports:

a) per-user tokens and secrets (so each user uses a different "app")

b) configuration of the default token and secret at build time

What this means for developers is that you need to supply two build options with the key and the secret before the software will build. To stop them being trivially identifiable, we base64 encode them.

If you wish to build your own "micro-fork" of the application then register at developer.twitter.com and create an application. To base64 encode the keys you can run echo -n "<value>" | base64.

Reasons you may wish to micro-fork Cawbird:

Alternatively you can continue using the default keys by using the values VmY5dG9yRFcyWk93MzJEZmhVdEk5Y3NMOA== and MThCRXIxbWRESDQ2Y0podzVtVU13SGUyVGlCRXhPb3BFRHhGYlB6ZkpybG5GdXZaSjI= respectively.

Compiling

Cawbird uses the Meson build system rather than the more archaic autoconf/make combination. Building is as simple as:

meson build -Dconsumer_key_base64=<your-base64-key> -Dconsumer_secret_base64=<your-base64-secret>
ninja -C build

If you want to test translations locally then you will also need to:

Note that executing build/cawbird may result in one of the following errors:

Settings schema 'uk.co.ibboard.cawbird' is not installed

Settings schema 'uk.co.ibboard.cawbird' does not contain a key named 'foo'

To fix this, use the schemas from the build directory:

GSETTINGS_SCHEMA_DIR=build/data/ GSETTINGS_BACKEND='memory' build/cawbird

Cawbird installs its application icon into /usr/share/icons/hicolor/, so an appropriate call to gtk-update-icon-cache might be needed.

Build Dependencies

Note that the above packages are just rough estimations, the actual package names on your distribution may vary and may require additional repositories (e.g. RPMFusion in Fedora, or Packman in openSUSE)

If you pass -Dvideo=false to the Meson script, you don't need any gstreamer dependency but won't be able to view any videos.

Copyright

Cawbird is released under the GPL v3 (or later) - see COPYING for more details.

The video fallback image is a Creative Commons "CC-BY-3.0" licensed work by Iris Li.

Social Media

Footnotes

1: home:IBBoard:desktop