A Kotlin Multiplatform client for Lemmy.
|
|
|
|
|
|
|
|
Raccoon for Lemmy is a client for the federated aggregation and discussion platform Lemmy.
The project started as an exercise to play around with Kotlin Multiplatform (KMP) and Compose multiplatform (CMP) and gradually grew as a fully functional client.
Here are some options to install the application on your device, apart from downloading the APKs from the Releases page.
Tip
On Obtainium, please make sure to check the "Include pre-releases" option: by doing so you will be able to receive all alpha and beta builds automatically.
Warning
Starting from version 1.13.0-beta01 (118) the application ID has changed so if you are running Raccoon 1.13.0-20240730-pre or earlier version you are not receiving updates any more and you are encouraged to upgrade. You can save a backup of your settings using the "Export settings to file" option in the "Advanced Setting" screen and reimporting the JSON using "Import settings from file" in the new app.
- view post feed and comments with different listing and sort types;
- possibility to upvote and downvote (with configurable swipe actions);
- community and user detail;
- review your own posts and comments (created by you, bookmarked, liked/disliked);
- inbox with replies, mentions and direct messages;
- global search on Lemmy with different result types (all, posts, comments, user, communities);
- create and edit new posts (with optional images);
- cross-post contents to other communities;
- reply to post and comments (and edit replies);
- mark posts as read and hide read contents;
- custom appearance (color scheme, fonts, text sizes, post layout, etc.);
- custom localization (independent of system settings);
- block users, communities and instances;
- report post and comments to moderators;
- support for multiple accounts (and multiple instances) with account-specific settings;
- lazy scrolling (referred to as "zombie mode");
- explore all the communities on a given instance in guest mode;
- multi-community (community aggregation);
- community moderation, instance moderation and moderation log;
- save posts and comments you are creating as drafts to edit them later.
Most clients for Lemmy currently offer the first points (with various degrees of completion), so there is nothing special about Raccoon, whereas the last ones are less common and are directed to more demanding users.
Concerning customization, the ability to change some aspects like font face or size and app colors, vote format, bar transparency and so on was of paramount importance from the very beginning. Similarly, users should be able to use the app in their native language and change the UI language independently of the system language.
This app is also intended for moderators who want to use their mobile device, offering moderation tools (feature post, lock post, distinguish comment, remove post/comment, ban users) and the ability to revert any of these actions. It also has admin tools (purge users/posts/comments/communities, feature posts locally, hide/unhide communities) to simplify admin moderation without having to switch to the web UI.
The project is under active development, so expect new features to be added over time. Have a look on the issues labeled with "feature" in the issue tracker to get an idea of what's going to come next.
If you have ideas, feedback, suggestions or comments remember to speak up and use your voice. You can add reports or request features and they will be considered.
Because raccoons are so adorable, aren't they? 🦝🦝🦝
Joking apart, one of the main goals was to experiment with KMP and learn how to properly deal with the challenges of a multiplatform environment, and a medium-sized project like this was an ideal testing ground for that technology.
Secondly, I felt that the Android ecosystem of Lemmy apps was a little "poor" with few native apps (fewer open source), while the "market" is dominated by iOS and cross-platform clients. I️ ❤️ Kotlin, I ❤️ Free and Open Source Software and I ❤️ native app development, so there was a niche that could be filled.
Developing a new client was an opportunity to add all the good features that were "scattered" across different apps, e.g. the feature richness of Liftoff, the multi-community feature of Summit and the polished UI of the really great Thunder and so on. This app tries to be configurable enough to make users feel "at home" and choose what they want, while at the same time having a not too cluttered interface.
In the third place, this app has been a means to dig deeper inside Lemmy's internals and become more humble and patient towards other apps because there are technical difficulties in having to deal with a platform like Lemmy.
This project is all about experimenting and learning, so please be patient.
- Calf for a web view implementation;
- Coil for image loading;
- Compose Multiplatform for UI;
- Compose ColorPicker for custom color selection;
- Compose Multiplatform Media Player for video playback;
- Koin for dependency injection;
- Ktor and Ktorfit for networking;
- Lyricist for localization;
- Multiplatform Markdown Renderer for Markdown rendering
- Multiplatform Settings for encrypted shared preferences;
- MaterialKolor for custom theme generation;
- SQLDelight and SQLCipher for local persistence
- Voyager for navigation;
More info about the technologies used in the project can be found in the CONTRIBUTING.md.
- subscribe to our Lemmy community to receive updates about the new releases, participate into public discussions, share your feedback or suggestions;
- join the Matrix room of this project to reach out to the developers and other users;
- open an issue on this project's issue tracker to report bugs or request new features
- if you are a translator and want to help out with l10n or submit some corrections but you don't feel confident with repository forks, pull requests, managing resource files, etc. feel free to drop an email or contact the maintainers.
Please remember: every contribution is welcome and everyone's opinion matters here. This is a community project, open source, ad-free and free of charge, and it belongs to us all so don't be afraid to get involved.
And don't forget every 🦝's motto: #livefasteattrash.
Warning
This is an experimental project and some technologies it is build upon are still in pre-production stage, moreover this is a side-project developed by volunteers in their spare time, so use at your own risk.
This means you should be prepared to occasional failures, yet-to-implement features and areas where some polish is needed.
Contributions are welcome and new feature requests will be evaluated depending on the available time, considering the project is maintained by volunteers.