app-template/app/docs/en/index.md

56 lines
1.9 KiB
Markdown

---
layout: home
hero:
name: Fanmu
text: Your own media library, with danmaku
tagline: Mount a cloud drive, play video in the browser, and get online danmaku on top. No desktop client needed.
actions:
- theme: brand
text: What it does
link: /en/guide/what-is
- theme: alt
text: Get started
link: /en/guide/quick-start
features:
- title: Mount and play
details: Hook up a WebDAV drive and play right in the browser. The password stays on the server.
- title: Video with danmaku
details: Danmaku is matched automatically, the same way DanDanPlay does for local files. You can also import a local XML file.
- title: Knows what you are watching
details: Scans figure out the show and episode, then pull in posters and metadata. Fix a wrong match by hand if needed.
- title: Built for households
details: Multiple accounts. Everyone gets their own library and watch progress.
---
## What is this
**Fanmu** is a media library you host yourself.
Your videos live on a cloud drive (WebDAV, including OpenList's WebDAV endpoint). Mount it in Fanmu and play in the browser, with danmaku.
The idea is close to DanDanPlay: local video plus online danmaku. Fanmu just runs in the browser, so you do not install a player on every machine.
## What you can do
| Task | Guide |
|------|-------|
| [Mount a drive](/en/guide/mount) | Connect WebDAV |
| [Find a video](/en/guide/browse) | Browse folders and play |
| [Library](/en/guide/library) | Scan in shows, posters, resume |
| [Watch and danmaku](/en/guide/danmaku) | Playback, danmaku, styling |
| [Identify the show](/en/guide/scrape) | Auto match, or fix it yourself |
| [Accounts](/en/guide/account) | Sign in, private progress |
## Run it
```bash
yarn install
cp .env.example .env
yarn db:push && yarn db:seed
yarn dev:web
```
Open `http://localhost:4321` — English lives at `/en`. More detail in [Get started](/en/guide/quick-start).