Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update readme #40

Merged
merged 2 commits into from
Jun 16, 2024
+32 −2
Merged

Update readme #40

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a7b36e0
fix: dead link
anatawa12 Jun 16, 2024
c757724
docs: add Notes for Third-party Client Developers
anatawa12 Jun 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,36 @@ After that, you have two ways to use the Vmimi Relay Timeline:
[`vmimi-relay-timeline/generic`] ブランチをあなたのフォークにマージすることで、この拡張を使用できます。
必要であれば、あなたのフォークにプルリクエストを作成します。お気軽にお尋ねください。

### Notes for Third-party Client Developers

Here are the technical notes for third-party misskey client developers.

サードパーティ Misskey クライアント向けの技術的な情報です

#### Detecting Vmimi Relay Timeline

There is `vmimiRelayTimelineImplemented` property on `metadata` object of `nodeinfo`.
If it's true, your client can assume that the VRTL is implemented for the sever.

`nodeinfo`の`metadata`オブジェクトに`vmimiRelayTimelineImplemented`プロパティがあります。
この値が true であれば、VRTLがそのサーバーにて実装されてると考えて問題ありません

#### Endpoints and Channels of Vmimi Relay Timeline

The fetch note endpoint for VRTL and VSTL are `notes/vmimi-relay-timeline` and `notes/vmimi-relay-hybrid-timeline`,
and the channel name for them are `vmimiRelayTimeline` and `vmimiRelayHybridTimeline`.

Those endpoints and channels have almost same options as LTL / STL but they have one extra option specific to VRTL/VSTL.
The `withLocalOnly` flag (true by default) indicates if the timeline should include local only (non-federated) notes from server (local) timeline.

For more details, see `misskey-js`.

VRTLとVSTLのfetchエンドポイントはそれぞれ `notes/vmimi-relay-timeline`と `notes/vmimi-relay-hybrid-timeline`で、
チャンネルは `vmimiRelayTimeline` と `vmimiRelayHybridTimeline` です。

これらのエンドポイントとチャンネルは LTL/STL とほぼ同じオプションを持っていますが、 VRTL/VSTL に固有オプションが一つあります。
`withLocalOnly` (デフォルトtrue) はタイムラインにローカルのみ(連合なし)ノートがタイムラインに含まれるかどうかを示します。

### Branches related to Vmimi Relay Timeline

- [`vmimi-relay-timeline/generic`]:
Expand Down Expand Up @@ -90,8 +120,8 @@ non-federated notes, but this behavior may change in the future.
[Virtual Kemomimi Relay]: https://relay.virtualkemomimi.net/
[misskey.niri.la]: https://github.com/niri-la/misskey.niri.la/
[vmimi-relay timeline]: #vmimi-relay-timeline
[`vmimi-relay-timeline/generic`]: https://github.com/anatawa12/misskey/tree/vmimi-relay-timeline
[`vmimi-relay-timeline/releases`]: https://github.com/anatawa12/misskey/tree/vmimi-relay-timeline-releases
[`vmimi-relay-timeline/generic`]: https://github.com/anatawa12/misskey/tree/vmimi-relay-timeline/generic
[`vmimi-relay-timeline/releases`]: https://github.com/anatawa12/misskey/tree/vmimi-relay-timeline/releases
[`ghcr.io/anatawa12/vrtl-misskey:latest`]: https://github.com/anatawa12/misskey/pkgs/container/vrtl-misskey

---
Expand Down