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

1 Anonymous user

1.1 Home screen

The home screen 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 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).

home screen floating action button menu

1.2 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.

post detail see raw post

1.3 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.

side menu select instance add instance

It is possible to reorder items in this list to arrange how instances are displayed.

1.4 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 (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.

community detail user info

1.5 User detail

Conversely, if you tap on the user name above the title, you will access the user detail screen where it is possible to see the posts and comments created by that particular user.

If you tap on the “⋮” button in the top right corner you can also access some additional information.

user detail user info

1.6 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.

explore

1.7 Profile and Inbox

In anonymous mode the profile and inbox screens are just placeholders that invite you to access with an account.

anonymous profile anonymous inbox

1.8 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.github.diegoberaldin.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

1.8.1 Application appearance

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

By the way, if you like Android dynamic colors and you think that on Lemmy there are plenty of beautiful images you could set as your home screen background, have a look at this side project of mine. It is a simple app that allows you to configure remote image sources from the Lemmy-verse, preview how they look like and set them easily as wallpapers for your home and lock screens.

colors and fonts

1.8.2 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 settings second part

1.8.3 Advanced settings

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

settings first part

1.9 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

2 Logged user

2.1 Home

When you are logged, as for anonymous users, the home screen contains the post list with the same information displayed. The main difference is that, as a logged user, you can save posts and vote (either up or down) contents. You will also find more options in the “…” button.

The floating action button contains an option to hide read posts for logged users, 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.

post list floating action button

2.2 Sidebar

The side menu allows to see the list of subscriptions, with the ones that you marked as favorite to the top of the list. By clicking on each item, you will open the corresponding community or multi-community detail.

You can use the search field to look for a specific community.

side bar

2.3 Explore

The Explore screen is similar to the one of anonymous users. Like in the home screen, the difference if that you can vote, save and reply to contents you are seeing.

explore

2.4 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.

Above the post and comments, you can find the shortcuts to access the following sections:

In the top right corner of the app bar, you’ll find a button to log out and another one to change account (or access with a different one).

profile manage accounts

2.5 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.

inbox

2.6 Settings

The settings screen for logged users is very similar to the one of anonymous users, but it has some additional items and sub-screens.

Please refer to description of the page for anonymous users for the common parts, a short description of the additional functions will follow.

settings 1 settings 3

2.6.1 Application appearance

This screen is similar to the one for anonymous users, but additionally it allows to configure custom colors for swipe actions:

2.6.2 Advanced settings

Even in this case, the screen is very similar to the one anonymous users are presented, but it has some additional options:

2.6.2 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

2.6.3 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

2.6.4 Ban and filter options

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

2.7 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