/chooj

Matrix chat app for KaiOS supporting voice calls

Primary LanguageJavaScript

chooj

Matrix client for KaiOS with VoIP call support

Looking for sponsors! Contact me!

Chat on Matrix CodeFactor DeepScan grade Lines of code GitHub repo size GitHub Repo stars Licence badge KaiOS badge

This is a free(open source) software Matrix client for KaiOS which is going to support VoIP calls. Perhaps voice call is already working, in this case please send a Pull Request to update this README.

What does work so far?

  • Login process with password works(manually or by scanning a QR code)
  • Chatting works in all rooms. Sending text and voice is supported. You can view incoming text, voice and photos.
  • Voice call partially works.
  • Very experimental and unreliable push notification support which you can enable it in Settings
  • You can join public rooms. But there is a bug which you must restart the app after joining.
  • The Cow says "Please wait" to you kindly :))

How to help?

  • Create an issue and report a bug
  • Open a Pull Request and implement some wanted feature or fix some bug
  • Donate to me (see below)
  • Tell others about chooj
  • Idle in chooj's Matrix room and help others when necessary
  • Solve one of the issues.
  • ...

Matrix chatroom for chooj

This project has got a Matrix room. See badges.

Nightly builds

  • You can download and sideload ZIP for each time I push stuff from here.
  • OmniSD builds are available there, too!
  • Thanks to hashbang which let's me host stuff there.
  • Old ZIPs will be deleted after a some time.
  • Please allow a few minutes(1-2) after each commit and the file will show up there.

NOTE: While I try to test stuff before pushing but you might find some broken builds there. There is no automated test yet.

Device compatiblity

This app should work on all KaiOS versions. However it has been also tested on these devices:

  • Nokia 8110 4G(aka The BananaPhone)
  • Nokia 800 Tough
  • Alcatel Go Flip 3 4052W (related issue)
  • [Add your own device here]

How to build?

The production build is currently broken and you may only use development builds.

  • Install Node v18.x if you haven't
  • Install yarn if you haven't
  • yarn install in project's directory
  • yarn devbuild to create a development build(faster build at the cost of heavier bundle) or yarn build for production builds
  • (Optional) remove the Javascript modules from index.html as well as the related file(s).
  • Now you can sideload the application in build/ to your device.

You can check guides on how to prepare your device for sideloading stuff and development at the BananaHackers wiki and website linked below:

Why Github?

See this post to learn why I initially chose Github. For future, I might switch to a reliable Gitlab instance(other than gitlab.com) or even have both Github repository and a Gitlab repo and have them in sync. A Gitlab instance exclusively for chooj is also possible if someone funds it but very improbable.

Why InfernoJS?

See this post

Why Matrix?

Matrix fans fill stuff here :D

Related BananaHackers blog posts

Donations

Donations are very welcome in the form of cryptocurrency(Bitcoin Cash is preferred). These people have donated to help fund the project:

  • wreck
  • A few from BananaHackers community donated a phone

Because depth of pockets of different people varies, I haven't specified how much each donated.

Donating money

You can donate a monthly amount through chooj's bountysource page.

Donating cryptocurrency

You can make donations anonymously by sending an amount to my Bitcoin Cash address:

bitcoincash:qpxy55al8k3mux7j58taxt88jukmqur5ruv6tz7mkc

If you want me to mention your name in the list, please send me the source address before sending donation:

fkz atsine riseup dot net

You can also send me private key of a Bitcoin Cash wallet.

In the case you don't have crypto already, you can buy Bitcoin Cash from stealthex.io and enter my address as recipient address.

Donating hardware

You can also donate KaiOS phones or other hardwares. KaiOS phones with one of more of these properties which are debug enabled will help with the development of project:

  • KaiOS 3.x
  • 256MB of RAM
  • A processor weaker than SD205 which is used in my Nokia phone
  • Selfie/front camera
  • Volume buttons

You can also donate me some other hardware which could be useful for my personal life. But in either case, especially donating KaiOS phone, contact me beforehand.

License

This project is free software under GNU GPLv3 and comes without any warranty from author(s) of the project.

These files however are under different license(s):

  • waiting.ogg: Downloaded from here under CC0