Raccoon for Lemmy

Raccoon for Lemmy 🦝 documentation

View on GitHub

User manual

This page contains a short description of the main features of the app.

Table of contents

Home screen

The home screen displays the timeline and it is made up by three components:

The format of each post item (card, compact or full) and the vote format (aggregated, separated, percentage) as well as the font size/face can be configured in the Settings screen.

If you are logged, you can save posts and vote then (with either a positive or a negative vote). You will also find more options in the “…” button.

If you open the menu of the floating action button in the bottom right corner, you can go back to the top or activate the “zombie mode” (i.e. automatic scrolling).

If you are logged, the floating action button contains an option to hide read posts — a post is considered read when you have voted or saved it, opened its detail, opened its image or (if you enabled the “Mark read while scrolling” option in the Settings screen) just seen it in the feed.

home screen floating action button menu

Back to top

Side menu

In anonymous mode, the side menu gives you the opportunity to change instance (the same menu can be accessed by tapping the “via …” label in the home top bar).

If your preferred instance is not listed, you can add a new one using the “+” button. It is possible to reorder items in this list to arrange how instances are displayed.

If you are logged, the side menu allows to see the list of subscriptions, with the ones that you marked as favorite to the top of the list. You can use the search field to look for a specific community.

By clicking on each item, you will open the corresponding community or multi-community detail.

side menu select instance add instance

Back to top

Post detail

By selecting a post you can open the corresponding detail screen.

The detail screen shows the post creator and community info, title, cover image, URL, score and date but also the textual body of the post if it is present.

After the post you can see the comments, each of which displays the creator, date, number of replies and vote.

By using the “…” button you can access an additional menu about the post, e.g. you can see the raw Markdown and inspect/copy its contents.

If you are logged, you can vote or save both the main post and all its comments.

post detail

Back to top

Community detail

By tapping on the community info above each post title, you can open the community detail screen, which is very similar to the home screen (you can activate the zombie mode here too).

If you tap on the “⋮” button in the top right corner you can also access some additional information and, if you are logged and are a moderator for this community, you will be able to edit its metadata.

If you are logged, you can vote or save each post in the list and access the same post actions which you can find in the home screen timeline.

community detail user info

Back to top

Instance detail

From the “⋮” button of a community detail you can open the “Instance detail” page which shows a list of the communities in this instance (as well as a short description of the instance if it is available). This is useful because you can sort communities and explore the instance.

user info

Back to top

User detail

If you tap on the user name or avatar shown in the header of each post or comment, you will access the user detail screen where it is possible to see the posts and comments created by that particular user.

By using the “⋮” button in the top right corner you can also access some additional information.

user detail user info

Back to top

Explore

The explore screens allows you to search Lemmy (among All or local feeds) for contents and filter by a query string and result type (post, comment, communities, users or everything).

You can change the result type with the second to last action in the top bar, the available options are:

As in the home screen, you can change the sort type with the last action on the right in the top bar and, if you are logged, you can vote posts or save them.

explore explore

Back to top

Profile

The Profile screen shows the list of post and comments that you created and some textual statistics about your post and comment count and your Lemmy-birthday.

In top right corner an “open menu” button allows you to open a side menu which presents a series of shortcuts to access the following sections:

In anonymous mode the profile is just a placeholder that invite you to access with an account or retry the login if your token has expired.

anonymous profile anonymous profile

Back to top

Inbox

The Inbox screen is divided into three sections:

You can select (using the top bar) which filter to apply, i.e. whether all items should be included or just unread ones.

In anonymous mode the profile is just a placeholder that invite you to access with an account.

anonymous profile anonymous profile

Back to top

Settings

The settings screen allows you to customize the look and behaviour of your app.

* Look for a file named `crash_report.txt` in the Documents directory of the private storage area reserved for the app, e.g.

/sdcard/Android/data/com.livefast.eattrash.raccoonforlemmy.android.dev/files/Documents/crash_report.txt

via adb or the “Device Explorer” if you are using Android Studio.

settings first part settings second part

Back to top

Application appearance

This screen allows to configure colors and fonts of the UI:

colors and fonts

Back to top

Content appearance

This screen is useful to configure the aspect of Lemmy contents (usernames, community names, post and comments).

You can see a preview of the result below the list of options.

settings first part

Back to top

Advanced settings

This screen contains a series of less frequently used customization options:

settings first part settings first part

Back to top

Configure swipe actions

In this screen it is possible to assign an action to the 4 slots (two on the left side and two on the right side) of the cards used to render post, comments and inbox items.

configure swipe actions

Back to top

Web account settings

This screen lets you configure some preferences associated to your Lemmy account (similarly to what you can do on the webapp).

web settings

Back to top

Ban and filters

This screen allows you to see what users, communities and instances you have blocked and remove the block (these settings are tied to your Lemmy account too).

bans and filters

Back to top

Moderation log

The moderation log can be accessed from the community detail using the “⋮” button. It contains a list of all the actions that happened for that given community, e.g.:

moderation log

Back to top

Moderation tools

As a moderator, you can access the list of reports that users have submitted about posts and comments in your community. The report list can be accessed by the community detail, using the “⋮” button in the top right corner.

The report list screen can be filtered like the inbox (including all items or just unresolved ones) and it is divided in two sections:

For each report you can see the reason that was specified by the reporting users, you can open the content (e.g. to remove it) and you can mark the report as “resolved” once you are done with it.

report list

Back to top