Skip to content

Commit 6bf8326

Browse files
sioaekoclaude
sioaeko
and
claude
committed
Add README in 4 languages with screenshots
English, Korean, Japanese, Chinese documentation with app screenshots for main UI, playback, heatmap, Handy connection, EroScripts search, and settings. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 4f9d72f commit 6bf8326

File tree

12 files changed

+432
-0
lines changed

12 files changed

+432
-0
lines changed

‎README.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
<p align="center">
2+
<img src="public/icon.png" width="128" height="128" alt="ScriptPlayer+ Icon">
3+
</p>
4+
5+
<h1 align="center">ScriptPlayer+</h1>
6+
7+
<p align="center">
8+
A modern funscript video player with <b>The Handy</b> integration, <b>EroScripts</b> browser login, and multi-language support.
9+
</p>
10+
11+
<p align="center">
12+
<a href="README.md">English</a> · <a href="docs/README_KO.md">한국어</a> · <a href="docs/README_JA.md">日本語</a> · <a href="docs/README_ZH.md">中文</a>
13+
</p>
14+
15+
---
16+
17+
## Screenshots
18+
19+
| Main Interface | Playing with Timeline & Heatmap |
20+
|:-:|:-:|
21+
| ![Main](docs/screenshots/main.png) | ![Playing](docs/screenshots/playing_mode1.png) |
22+
23+
| Heatmap & Timeline Detail | Handy Device Connection |
24+
|:-:|:-:|
25+
| ![Heatmap](docs/screenshots/heatmap.png) | ![Handy](docs/screenshots/handy_connect.png) |
26+
27+
| EroScripts Search | Settings |
28+
|:-:|:-:|
29+
| ![Scripts](docs/screenshots/scripts_search.png) | ![Settings](docs/screenshots/setting.png) |
30+
31+
## Features
32+
33+
- **Video Player** — Play local video files (MP4, MKV, AVI, WebM, MOV, WMV) with full playback controls
34+
- **Funscript Support** — Automatically loads matching `.funscript` files alongside videos
35+
- **Timeline Visualization** — Real-time scrolling timeline showing script action points with speed-based colors
36+
- **Heatmap** — Full-video intensity heatmap (green → yellow → orange → red → purple)
37+
- **The Handy Integration** — Connect and sync The Handy device via HSSP protocol
38+
- Auto-connect & connection history
39+
- Script auto-upload to Handy servers
40+
- Time offset adjustment
41+
- Stroke range customization
42+
- **EroScripts Integration** — Search and download funscripts directly from EroScripts via in-app browser login (no API key needed)
43+
- **Multi-Language** — English, 한국어, 日本語, 中文
44+
- **Drag & Drop** — Drop video files directly into the player
45+
- **Folder Browser** — Browse folders with subfolder grouping and script detection (green checkmark)
46+
- **Keyboard Shortcuts** — Space, Arrow keys, F (fullscreen), M (mute), and more
47+
- **Cross-Platform** — Windows (standalone) and macOS (via GitHub Actions)
48+
49+
## Installation
50+
51+
### Windows
52+
53+
1. Download the latest release from [Releases](https://github.com/sioaeko/scriptplayer-plus/releases)
54+
2. Extract and run `ScriptPlayerPlus.exe` — no installation required
55+
56+
### Build from Source
57+
58+
```bash
59+
git clone https://github.com/sioaeko/scriptplayer-plus.git
60+
cd scriptplayer-plus
61+
npm install
62+
```
63+
64+
**Development:**
65+
```bash
66+
npm run electron:dev
67+
```
68+
69+
**Build Windows:**
70+
```bash
71+
npm run build:win
72+
```
73+
74+
**Build macOS** (requires macOS):
75+
```bash
76+
npm run build:mac
77+
```
78+
79+
## Keyboard Shortcuts
80+
81+
| Key | Action |
82+
|-----|--------|
83+
| `Space` / `K` | Play / Pause |
84+
| `←` / `→` | Seek ±5s |
85+
| `Shift + ←/→` | Seek ±10s |
86+
| `↑` / `↓` | Volume ±5% |
87+
| `F` | Toggle fullscreen |
88+
| `M` | Toggle mute |
89+
| `Ctrl + ,` | Open settings |
90+
91+
## Tech Stack
92+
93+
- **Electron** — Desktop application framework
94+
- **React** + **TypeScript** — UI components
95+
- **Tailwind CSS** — Styling
96+
- **Vite** — Build tool
97+
- **Handy API v2** — Device communication
98+
- **Discourse API** — EroScripts integration
99+
100+
## License
101+
102+
MIT
103+
104+
---
105+
106+
<p align="center">
107+
Built with Electron, React, and Tailwind CSS
108+
</p>

‎docs/README_JA.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
<p align="center">
2+
<img src="../public/icon.png" width="128" height="128" alt="ScriptPlayer+ アイコン">
3+
</p>
4+
5+
<h1 align="center">ScriptPlayer+</h1>
6+
7+
<p align="center">
8+
<b>The Handy</b>連携、<b>EroScripts</b>ブラウザログイン、多言語対応のモダンなファンスクリプトビデオプレーヤー
9+
</p>
10+
11+
<p align="center">
12+
<a href="../README.md">English</a> · <a href="README_KO.md">한국어</a> · <a href="README_JA.md">日本語</a> · <a href="README_ZH.md">中文</a>
13+
</p>
14+
15+
---
16+
17+
## スクリーンショット
18+
19+
| メイン画面 | 再生（タイムライン＋ヒートマップ） |
20+
|:-:|:-:|
21+
| ![メイン](screenshots/main.png) | ![再生](screenshots/playing_mode1.png) |
22+
23+
| ヒートマップ＆タイムライン詳細 | Handyデバイス接続 |
24+
|:-:|:-:|
25+
| ![ヒートマップ](screenshots/heatmap.png) | ![Handy](screenshots/handy_connect.png) |
26+
27+
| EroScripts検索 | 設定 |
28+
|:-:|:-:|
29+
| ![スクリプト](screenshots/scripts_search.png) | ![設定](screenshots/setting.png) |
30+
31+
## 主な機能
32+
33+
- **ビデオプレーヤー** — ローカル動画ファイルの再生（MP4、MKV、AVI、WebM、MOV、WMV）
34+
- **ファンスクリプト対応** — 動画と同名の`.funscript`ファイルを自動読み込み
35+
- **タイムライン表示** — スクリプトのアクションポイントを速度別の色でリアルタイム表示
36+
- **ヒートマップ** — 動画全体の強度を色で可視化（緑→黄→オレンジ→赤→紫）
37+
- **The Handy連携** — HSSPプロトコルでThe Handyデバイスと同期
38+
- 自動接続＆接続履歴
39+
- スクリプト自動アップロード
40+
- 時間オフセット調整
41+
- ストローク範囲のカスタマイズ
42+
- **EroScripts連携** — アプリ内ブラウザログインでファンスクリプトの検索・ダウンロード（APIキー不要）
43+
- **多言語対応** — English、한국어、日本語、中文
44+
- **ドラッグ＆ドロップ** — 動画ファイルを直接プレーヤーにドロップ
45+
- **フォルダブラウザ** — サブフォルダグループ化とスクリプト検出（緑チェックマーク）
46+
- **キーボードショートカット** — Space、矢印キー、F（フルスクリーン）、M（ミュート）など
47+
- **クロスプラットフォーム** — Windows（スタンドアロン）およびmacOS（GitHub Actions経由）
48+
49+
## インストール
50+
51+
### Windows
52+
53+
1. [Releases](https://github.com/sioaeko/scriptplayer-plus/releases)から最新バージョンをダウンロード
54+
2. 解凍して`ScriptPlayerPlus.exe`を実行 — インストール不要
55+
56+
### ソースからビルド
57+
58+
```bash
59+
git clone https://github.com/sioaeko/scriptplayer-plus.git
60+
cd scriptplayer-plus
61+
npm install
62+
```
63+
64+
**開発モード：**
65+
```bash
66+
npm run electron:dev
67+
```
68+
69+
**Windowsビルド：**
70+
```bash
71+
npm run build:win
72+
```
73+
74+
**macOSビルド**（macOS必要）：
75+
```bash
76+
npm run build:mac
77+
```
78+
79+
## キーボードショートカット
80+
81+
| キー | アクション |
82+
|------|-----------|
83+
| `Space` / `K` | 再生 / 一時停止 |
84+
| `←` / `→` | ±5秒シーク |
85+
| `Shift + ←/→` | ±10秒シーク |
86+
| `↑` / `↓` | 音量 ±5% |
87+
| `F` | フルスクリーン切替 |
88+
| `M` | ミュート切替 |
89+
| `Ctrl + ,` | 設定を開く |
90+
91+
## 技術スタック
92+
93+
- **Electron** — デスクトップアプリケーションフレームワーク
94+
- **React** + **TypeScript** — UIコンポーネント
95+
- **Tailwind CSS** — スタイリング
96+
- **Vite** — ビルドツール
97+
- **Handy API v2** — デバイス通信
98+
- **Discourse API** — EroScripts連携
99+
100+
## ライセンス
101+
102+
MIT
103+
104+
---
105+
106+
<p align="center">
107+
Electron、React、Tailwind CSSで構築
108+
</p>

‎docs/README_KO.md‎

Lines changed: 108 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,108 @@
1+
<p align="center">
2+
<img src="../public/icon.png" width="128" height="128" alt="ScriptPlayer+ 아이콘">
3+
</p>
4+
5+
<h1 align="center">ScriptPlayer+</h1>
6+
7+
<p align="center">
8+
<b>The Handy</b> 연동, <b>EroScripts</b> 브라우저 로그인, 다국어 지원을 갖춘 모던 펀스크립트 비디오 플레이어
9+
</p>
10+
11+
<p align="center">
12+
<a href="../README.md">English</a> · <a href="README_KO.md">한국어</a> · <a href="README_JA.md">日本語</a> · <a href="README_ZH.md">中文</a>
13+
</p>
14+
15+
---
16+
17+
## 스크린샷
18+
19+
| 메인 화면 | 재생 (타임라인 + 히트맵) |
20+
|:-:|:-:|
21+
| ![메인](screenshots/main.png) | ![재생](screenshots/playing_mode1.png) |
22+
23+
| 히트맵 & 타임라인 상세 | Handy 디바이스 연결 |
24+
|:-:|:-:|
25+
| ![히트맵](screenshots/heatmap.png) | ![Handy](screenshots/handy_connect.png) |
26+
27+
| EroScripts 검색 | 설정 (한국어) |
28+
|:-:|:-:|
29+
| ![스크립트](screenshots/scripts_search.png) | ![설정](screenshots/setting_kor.png) |
30+
31+
## 주요 기능
32+
33+
- **비디오 플레이어** — 로컬 영상 파일 재생 (MP4, MKV, AVI, WebM, MOV, WMV)
34+
- **펀스크립트 지원** — 영상과 같은 이름의 `.funscript` 파일 자동 로드
35+
- **타임라인 시각화** — 스크립트 액션 포인트를 속도별 색상으로 실시간 표시
36+
- **히트맵** — 전체 영상의 강도를 색상으로 한눈에 확인 (초록 → 노랑 → 주황 → 빨강 → 보라)
37+
- **The Handy 연동** — HSSP 프로토콜로 The Handy 디바이스와 동기화
38+
- 자동 연결 & 연결 기록
39+
- 스크립트 자동 업로드
40+
- 시간 오프셋 조정
41+
- 스트로크 범위 커스터마이징
42+
- **EroScripts 연동** — 앱 내 브라우저 로그인으로 펀스크립트 검색 및 다운로드 (API 키 불필요)
43+
- **다국어 지원** — English, 한국어, 日本語, 中文
44+
- **드래그 & 드롭** — 영상 파일을 플레이어에 바로 드롭
45+
- **폴더 브라우저** — 하위 폴더 그룹핑 및 스크립트 유무 표시 (초록 체크마크)
46+
- **키보드 단축키** — Space, 방향키, F (전체화면), M (음소거) 등
47+
- **크로스 플랫폼** — Windows (스탠드얼론) 및 macOS (GitHub Actions)
48+
49+
## 설치
50+
51+
### Windows
52+
53+
1. [Releases](https://github.com/sioaeko/scriptplayer-plus/releases)에서 최신 버전 다운로드
54+
2. 압축 해제 후 `ScriptPlayerPlus.exe` 실행 — 설치 불필요
55+
56+
### 소스에서 빌드
57+
58+
```bash
59+
git clone https://github.com/sioaeko/scriptplayer-plus.git
60+
cd scriptplayer-plus
61+
npm install
62+
```
63+
64+
**개발 모드:**
65+
```bash
66+
npm run electron:dev
67+
```
68+
69+
**Windows 빌드:**
70+
```bash
71+
npm run build:win
72+
```
73+
74+
**macOS 빌드** (macOS 필요):
75+
```bash
76+
npm run build:mac
77+
```
78+
79+
## 키보드 단축키
80+
81+
| 키 | 기능 |
82+
|-----|------|
83+
| `Space` / `K` | 재생 / 일시정지 |
84+
| `←` / `→` | ±5초 이동 |
85+
| `Shift + ←/→` | ±10초 이동 |
86+
| `↑` / `↓` | 볼륨 ±5% |
87+
| `F` | 전체화면 전환 |
88+
| `M` | 음소거 전환 |
89+
| `Ctrl + ,` | 설정 열기 |
90+
91+
## 기술 스택
92+
93+
- **Electron** — 데스크톱 애플리케이션 프레임워크
94+
- **React** + **TypeScript** — UI 컴포넌트
95+
- **Tailwind CSS** — 스타일링
96+
- **Vite** — 빌드 도구
97+
- **Handy API v2** — 디바이스 통신
98+
- **Discourse API** — EroScripts 연동
99+
100+
## 라이선스
101+
102+
MIT
103+
104+
---
105+
106+
<p align="center">
107+
Electron, React, Tailwind CSS로 제작
108+
</p>

0 commit comments

Comments
 (0)