Skip to content

Latest commit

 

History

History
104 lines (84 loc) · 4.25 KB

README-EN.md

File metadata and controls

104 lines (84 loc) · 4.25 KB
Raw

Milktea

Would you like Milktea with Misskey?
Misskey Android client app

Introduction

Milktea is Android client app for Misskey

Purpose

Milktea was developed to achieve following purposes.

  • Provide as like Android UI
  • Support as many Misskey features as possible
  • Comfortable touch even if you have migrated from other social network apps
  • Unique features to make Milktea easier to use
  • Get more people to use Misskey
  • Develop Milktea on an ongoing basis

Features

Timeline

Milktea can displaies Timeline from Misskey instance in real time.

Timeline Tab function

You can fix and rearrange the most frequently viewed Timeline at the top of tabs.
The tab function can be used to fix below Timeline.

  • Global Timeline
  • Social Timeline
  • Local Timeline
  • Home Timeline
  • User List Timeline
  • List of user's Notes
  • Search result
  • Antenna Timeline
  • Gallery
  • List of Threads
  • Favorite
  • Notification

Posting Note

You can create and post Notes from Milktea.
There is no need to wait until the finish of its upload when posting Notes, because its upload is done asynchronously.

Reaction Picker

The function of making a reaction for Notes.
Reaction picker is categorized by (custom)emojis on the tabs.

  • Pinned user's setting
  • Frequently used emojis
  • Several (custom)emoji categories

Save drafts of Notes

This is one of the unique feature for Milktea.
You can save a draft of Notes while creating it.

Drive

You can see your own files in Misskey Drive.

Overwrite display name

In Misskey, there was a case that the Name displayed on the screen was different from the nickname which used in the conversation between Misskey users. It was very complicated to have a difference of Name and the nickname. So, I implemented a function to overwrite the nickname and only display it on Milktea.

Installation

Download from Google Play Store and install into your device.

Create your account on the instance you wish to use.
About Misskey / List of Instances

Launch the app after its installation is complete. When "Authentication" screen appears, type Misskey instance URL you're trying to use. For example, when you want to use misskey.io, type misskey.io .

You can freely change "App name".
"App name" maybe displaied with "via" on the instance depending on a Misskey version of it.

Press AUTHENTICATION when you're ready.

The authentication screen will appear in your default browser. If there is no problem, click "Accept".
If you're not redirected to the app, press the "Back" button and press "I have given permission".

If successful, you will be redirected to Milktea and press "CONTINUE" to complete.

Build

git clone this repo and create a file secret.properties.

touch secret.properties

Add the following attributes to secret.properties to configure the settings about the relay server for push notifications.
To read more about the relay server for push notifications, please check below link.
https://github.com/pantasystem/MisskeyAndroidClient/blob/develop/PushToFCM/README.md

Set these settings for each variables:
Base URL for the push notification server for push_to_fcm.server_base_url
public_key generated by PushToFCM for push_to_fcm.public_key
auth_secret.txt generated by PushToFCM for push_to_fcm.auth

For example:

push_to_fcm.server_base_url=https://FooBarFooBar-pus
push_to_fcm.public_key=public_key
push_to_fcm.auth=auth_secret.txt

And then, build Milktea on Android SDK or AndroidStudio.