mirror of
https://gh-proxy.org/https://github.com/tiajinsha/JKVideo
synced 2026-07-08 23:43:52 +08:00
chore: prepare project for open source release
- Remove internal planning docs (CLAUDE.md, docs/, feature.md, livePlan.md) from git tracking - Add .gitignore rules to prevent re-tracking internal files - Add README.md (Chinese) and README.en.md (English) with screenshots, features, quick start - Add LICENSE (MIT) - Add CONTRIBUTING.md with dev setup, commit conventions, PR guide - Add CHANGELOG.md for v1.0.0 - Add .github/ issue templates (bug report, feature request) and PR template - Add public/ screenshots (p1-p6)
This commit is contained in:
Developer
184
README.en.md
Normal file
184
README.en.md
Normal file
@@ -0,0 +1,184 @@
|
||||
<div align="center">
|
||||
|
||||
<img src="https://img.shields.io/badge/JKVideo-Bilibili_Client-00AEEC?style=for-the-badge&logo=bilibili&logoColor=white" alt="JKVideo"/>
|
||||
|
||||
# JKVideo
|
||||
|
||||
**A feature-rich third-party Bilibili React Native client**
|
||||
|
||||
*DASH playback · Real-time danmaku · WBI signing · Live streaming · Cross-platform*
|
||||
|
||||
---
|
||||
|
||||
[](https://reactnative.dev)
|
||||
[](https://expo.dev)
|
||||
[](https://www.typescriptlang.org)
|
||||
[](LICENSE)
|
||||
[](README.en.md)
|
||||
|
||||
[中文](README.md) · [Quick Start](#quick-start) · [Features](#features) · [Contributing](CONTRIBUTING.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Screenshots
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td align="center"><img src="public/p1.jpg" width="180"/><br/><sub>Home · Inline Video · Live Cards</sub></td>
|
||||
<td align="center"><img src="public/p2.jpg" width="180"/><br/><sub>Video Detail · Info · Recommendations</sub></td>
|
||||
<td align="center"><img src="public/p3.jpg" width="180"/><br/><sub>Player · 4K HDR · Quality Switch</sub></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td align="center"><img src="public/p4.jpg" width="180"/><br/><sub>Downloads · LAN Share QR Code</sub></td>
|
||||
<td align="center"><img src="public/p5.jpg" width="180"/><br/><sub>Live Tab · Followed Streamers · Categories</sub></td>
|
||||
<td align="center"><img src="public/p6.jpg" width="180"/><br/><sub>Live Room · Real-time Danmaku · Guard Marks</sub></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
🎬 **Full DASH Playback**
|
||||
Bilibili DASH stream → `buildDashMpdUri()` local MPD → ExoPlayer native decode, supports 1080P+ & 4K HDR
|
||||
|
||||
💬 **Complete Danmaku System**
|
||||
Video danmaku with XML timeline sync + 5-lane floating overlay; Live danmaku via WebSocket with guard marks & gift counting
|
||||
|
||||
🔐 **WBI Signing**
|
||||
Pure TypeScript MD5 implementation, zero external crypto dependencies, 12h auto-cached nav interface
|
||||
|
||||
🏠 **Smart Home Layout**
|
||||
BigVideoCard inline DASH muted autoplay + swipe-to-seek gesture + live card interleaving + dual-column grid
|
||||
|
||||
📺 **Global Mini Player**
|
||||
Persistent bottom overlay player survives navigation, VideoStore cross-component state sync
|
||||
|
||||
🔑 **QR Code Login**
|
||||
QR code generation + 2s polling + automatic SESSDATA extraction from response headers
|
||||
|
||||
📥 **Download + LAN Sharing**
|
||||
Multi-quality background download, built-in HTTP server generates LAN QR code for same-Wi-Fi playback
|
||||
|
||||
🌐 **Cross-Platform**
|
||||
Android · iOS · Web, Expo Go scan-to-run in 5 minutes, Dev Build unlocks full DASH playback
|
||||
|
||||
---
|
||||
|
||||
## Tech Stack
|
||||
|
||||
| Layer | Technology |
|
||||
|---|---|
|
||||
| Framework | React Native 0.83 + Expo SDK 55 |
|
||||
| Navigation | expo-router v4 (file-based, Stack) |
|
||||
| State | Zustand |
|
||||
| HTTP | Axios |
|
||||
| Storage | @react-native-async-storage/async-storage |
|
||||
| Video | react-native-video (DASH MPD / HLS / MP4) |
|
||||
| Fallback | react-native-webview (HTML5 video injection) |
|
||||
| Pager | react-native-pager-view |
|
||||
| Icons | @expo/vector-icons (Ionicons) |
|
||||
|
||||
---
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Option 1: Expo Go (5 minutes, no build required)
|
||||
|
||||
> Some quality options limited; video falls back to WebView
|
||||
|
||||
```bash
|
||||
git clone https://github.com/your-username/JKVideo.git
|
||||
cd JKVideo
|
||||
npm install
|
||||
npx expo start
|
||||
```
|
||||
|
||||
Scan the QR code with [Expo Go](https://expo.dev/go) on Android or iOS.
|
||||
|
||||
### Option 2: Dev Build (Full features, recommended)
|
||||
|
||||
> Supports DASH 1080P+ native playback, full danmaku system
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npx expo run:android # Android
|
||||
npx expo run:ios # iOS (requires macOS + Xcode)
|
||||
```
|
||||
|
||||
### Option 3: Web
|
||||
|
||||
```bash
|
||||
npm install
|
||||
npx expo start --web
|
||||
```
|
||||
|
||||
> Web requires a local proxy server for image anti-hotlinking: `node scripts/proxy.js` (port 3001)
|
||||
|
||||
### Direct Install (Android)
|
||||
|
||||
Download the latest APK from [Releases](https://github.com/your-username/JKVideo/releases/latest) — no build needed.
|
||||
|
||||
> Enable "Install from unknown sources" in Android settings
|
||||
|
||||
---
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
app/
|
||||
index.tsx # Home (PagerView Hot/Live tabs)
|
||||
video/[bvid].tsx # Video detail (player + info/comments/danmaku)
|
||||
live/[roomId].tsx # Live room (HLS player + real-time danmaku)
|
||||
search.tsx # Search page
|
||||
downloads.tsx # Download manager
|
||||
settings.tsx # Settings (quality + logout)
|
||||
|
||||
components/ # UI components (player, danmaku, cards, etc.)
|
||||
hooks/ # Data hooks (video list, stream URLs, danmaku, etc.)
|
||||
services/ # Bilibili API wrapper (axios + cookie interceptor)
|
||||
store/ # Zustand stores (auth, download, playback, settings)
|
||||
utils/ # Utilities (format, image proxy, MPD builder)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Known Limitations
|
||||
|
||||
| Limitation | Reason |
|
||||
|---|---|
|
||||
| 4K / 1080P+ requires premium account | Bilibili API restriction |
|
||||
| FLV live streams not supported | Neither HTML5 nor ExoPlayer support FLV; HLS auto-selected |
|
||||
| Web requires local proxy | Bilibili image Referer anti-hotlinking |
|
||||
| Feed / like / collect features | Requires `bili_jct` CSRF token, not yet implemented |
|
||||
| QR code expires after 10 minutes | Close and reopen the login modal to refresh |
|
||||
|
||||
---
|
||||
|
||||
## Contributing
|
||||
|
||||
Issues and PRs are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) first.
|
||||
|
||||
---
|
||||
|
||||
## Disclaimer
|
||||
|
||||
This project is for personal learning and research purposes only. Not for commercial use.
|
||||
All video content copyright belongs to the original authors and Bilibili.
|
||||
This project is not affiliated with Bilibili in any way.
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE) © 2026 JKVideo Contributors
|
||||
|
||||
---
|
||||
|
||||
<div align="center">
|
||||
|
||||
If this project helps you, please give it a ⭐ Star!
|
||||
|
||||
</div>
|
||||
Reference in New Issue
Block a user