Skip to content

Commit 3cfed2c

Browse files
committed
feat: update README files with improved structure and additional language support
1 parent ff45d65 commit 3cfed2c

4 files changed

Lines changed: 719 additions & 561 deletions

File tree

‎README.ja.md‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
# DLsite Classification Manager
2+
3+
言語 Languages: [English](README.md) | [繁體中文](README.zh-TW.md) | [简体中文](README.zh-CN.md) | [日本語](README.ja.md)
4+
5+
高性能な DLsite 作品の分類・管理ツール。モダンな Web UI と完全な API を提供します。
6+
7+
## 🌟 機能特徴
8+
9+
- 高効率処理:async/await による高性能クローラーとファイル処理
10+
- スマートコード抽出:DLsite 作品コード(RJ, BJ, VJ, RE, BE, VE)を自動識別・抽出
11+
- 完全なメタデータ:タイトル、サークル、ジャンル、画像、紹介文など
12+
- モダンな Web インターフェース:Nuxt.js ベースのレスポンシブ UI
13+
- 強力な API:検索・フィルタリング・ソート対応の RESTful API
14+
- ユーザーコレクション:個人評価とコレクション分類
15+
- 複数のビューモード:グリッド / リスト表示
16+
- インテリジェント検索:マルチフィールド検索と高度なフィルタリング
17+
18+
## 🛠️ システム要件
19+
20+
- Python 3.8+
21+
- Node.js 16+
22+
- Yarn または npm
23+
24+
## 📦 インストール
25+
26+
### 1. リポジトリをクローン
27+
```
28+
git clone https://github.com/your-username/dlsite-classification.git
29+
cd dlsite-classification
30+
```
31+
32+
### 2. バックエンド依存関係をインストール
33+
```
34+
pip install -r requirements.txt
35+
```
36+
37+
### 3. フロントエンド依存関係をインストール
38+
```
39+
cd dlsite_classification_web
40+
yarn install
41+
# または npm install
42+
```
43+
44+
## 🚀 使い方
45+
46+
### バックエンドサービスを起動
47+
48+
1) コマンドライン分類ツール(インタラクティブ CLI)
49+
```
50+
python main.py
51+
```
52+
53+
2) Web API サーバー(ポート 8001)
54+
```
55+
# デフォルト設定
56+
python server.py
57+
58+
# データフォルダを指定
59+
python server.py --data-path /path/to/your/dlsite/data
60+
61+
# カスタムホスト / ポート
62+
python server.py --data-path ./test_game_info --port 8080 --host 127.0.0.1
63+
64+
# 環境変数を使用
65+
export DLSITE_DATA_PATH=/path/to/your/dlsite/data
66+
python server.py
67+
```
68+
69+
### フロントエンドを起動
70+
71+
```
72+
cd dlsite_classification_web
73+
74+
# 開発モード
75+
yarn dev
76+
77+
# 本番モード
78+
yarn build
79+
yarn preview
80+
```
81+
82+
`http://localhost:3000` または `http://localhost:3001` にアクセス。
83+
84+
## 🎯 チュートリアル
85+
86+
### 基本フロー
87+
88+
1) データ準備:DLsite 作品フォルダを指定ディレクトリに配置
89+
2) 分類実行:`python main.py` を実行してオプションを選択
90+
3) 結果確認:Web UI で分類結果を閲覧
91+
92+
### Web インターフェース機能
93+
94+
- 検索:キーワードで作品を検索
95+
- フィルタリング:サークル、ジャンル、コレクションなど
96+
- ビュー切替:グリッド / リスト
97+
- 作品詳細:カードをクリックして詳細表示
98+
- 評価・コレクション:詳細画面で設定
99+
100+
## 📊 データ形式
101+
102+
```
103+
[サークル名]_[サークルID]/
104+
├── [作品ID]_[サークル名]_[サークルID] 作品タイトル/
105+
│ ├── [作品ID]_info/
106+
│ │ ├── [作品ID]_img_main.jpg # メイン画像
107+
│ │ ├── [作品ID]_img_smp1.jpg # サンプル画像
108+
│ │ ├── code.tag # 作品コード
109+
│ │ ├── title.tag # 作品タイトル
110+
│ │ ├── company.tag # サークル情報
111+
│ │ └── ... その他のタグファイル
112+
```
113+
114+
## 🔧 設定
115+
116+
### データパス(優先順位)
117+
118+
1) コマンドライン引数
119+
```
120+
python server.py --data-path /path/to/your/dlsite/data
121+
```
122+
123+
2) 環境変数
124+
```
125+
export DLSITE_DATA_PATH=/path/to/your/dlsite/data
126+
python server.py
127+
```
128+
129+
3) デフォルトパス(順に検査)
130+
- `./test_game_info`
131+
- `/mnt/d/R18/DLsite`
132+
- `./data`
133+
134+
### サーバー
135+
136+
```
137+
# ポート
138+
python server.py --port 8080
139+
140+
# ホスト
141+
python server.py --host 127.0.0.1
142+
143+
# 完全設定
144+
python server.py --data-path ./data --port 8080 --host 0.0.0.0
145+
```
146+
147+
### コマンドライン引数
148+
149+
- `--data-path, -d`:データフォルダパス
150+
- `--port, -p`:サーバーポート(デフォルト 8001)
151+
- `--host`:サーバーホスト(デフォルト 0.0.0.0)
152+
- `--help`:ヘルプ
153+
154+
## 📡 API エンドポイント
155+
156+
- `GET /works`
157+
- `GET /work/{code}`
158+
- `GET /companies`
159+
- `GET /genres`
160+
- `POST /work/{code}/user-data`
161+
- `GET /image?path=<path>`
162+
163+
## 🔗 リンク
164+
165+
- プロジェクトホーム:https://github.com/your-username/dlsite-classification
166+
- 問題報告:https://github.com/your-username/dlsite-classification/issues
167+
- ライセンス:LICENSE
168+
169+
## 🤝 貢献
170+
171+
Pull Request と Issue を歓迎します!
172+
173+
## 📄 ライセンス
174+
175+
MIT License — `LICENSE` を参照。
176+

0 commit comments

Comments
 (0)