Skip to content

Commit 75af450

Browse files
author
Taois
committed
feat: 更新文档
1 parent d4f8ac0 commit 75af450

File tree

1 file changed

+230
-20
lines changed

1 file changed

+230
-20
lines changed

readme.md

Lines changed: 230 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,217 @@
1+
# 🎬 DrPlayer - 新一代智能视频播放器
2+
3+
<div align="center">
4+
5+
![DrPlayer Logo](https://img.shields.io/badge/DrPlayer-2.0-blue?style=for-the-badge&logo=play&logoColor=white)
6+
[![Vue 3](https://img.shields.io/badge/Vue-3.x-4FC08D?style=for-the-badge&logo=vue.js&logoColor=white)](https://vuejs.org/)
7+
[![Vite](https://img.shields.io/badge/Vite-5.x-646CFF?style=for-the-badge&logo=vite&logoColor=white)](https://vitejs.dev/)
8+
[![License](https://img.shields.io/badge/License-MIT-green?style=for-the-badge)](LICENSE)
9+
10+
**一款功能强大、智能化的现代视频播放器,支持多格式播放、智能跳过、直播功能等特色功能**
11+
12+
[🚀 在线演示](https://drplayer.playdreamer.cn/) | [📖 文档](https://hipy.playdreamer.cn/) | [🐛 问题反馈](https://github.com/your-repo/issues)
13+
14+
</div>
15+
16+
## ✨ 核心特色
17+
18+
### 🎯 智能播放体验
19+
- **🔄 双播放器引擎**:原生HTML5播放器 + ArtPlayer高级播放器,智能切换最佳播放方案
20+
- **🎬 智能跳过功能**:可配置的片头片尾自动跳过,告别重复内容,直达精彩部分
21+
- **⚡ 自动连播**:智能识别剧集,支持自动播放下一集,可自定义倒计时提醒
22+
- **📍 断点续播**:自动记录播放进度,随时随地继续观看
23+
24+
### 🌐 强大的兼容性
25+
- **📹 多格式支持**:完美支持 HLS (m3u8)、FLV、DASH (mpd)、MP4 等主流视频格式
26+
- **🛡️ CSP绕过技术**:智能绕过内容安全策略限制,大幅提升视频播放成功率
27+
- **🔍 智能格式检测**:自动识别视频格式并选择最佳播放策略
28+
- **📱 响应式设计**:完美适配桌面端、平板和移动设备
29+
30+
### 📺 丰富的直播功能
31+
- **🌍 海量直播源**:内置丰富的直播频道资源,包含4K频道、体育赛事、新闻资讯等
32+
- **📋 智能分组管理**:支持频道分类管理,快速定位想看的内容
33+
- **🔧 多格式解析**:支持 M3U8、M3U、TXT 等多种直播源格式
34+
35+
### ⚙️ 专业级功能
36+
- **🎛️ 多倍速播放**:支持 0.5x - 5x 多档位播放速度调节
37+
- **🎨 现代化UI**:基于 Arco Design 的精美界面设计
38+
- **🔧 高度可配置**:丰富的设置选项,满足不同用户需求
39+
- **🚀 性能优化**:基于 Vue 3 + Vite 的现代化架构,启动快速,运行流畅
40+
41+
## 🛠️ 技术栈
42+
43+
### 前端框架
44+
- **Vue 3** - 渐进式 JavaScript 框架
45+
- **Vite** - 下一代前端构建工具
46+
- **Pinia** - Vue 3 状态管理库
47+
- **Vue Router** - 官方路由管理器
48+
49+
### UI 组件库
50+
- **Arco Design Vue** - 企业级设计语言和组件库
51+
- **ECharts** - 数据可视化图表库
52+
53+
### 播放器技术
54+
- **ArtPlayer** - 现代化 HTML5 播放器
55+
- **HLS.js** - HLS 流媒体播放支持
56+
- **FLV.js** - FLV 格式播放支持
57+
- **Shaka Player** - DASH 流媒体播放支持
58+
59+
### 开发工具
60+
- **TypeScript** - 类型安全的 JavaScript
61+
- **ESLint** - 代码质量检查
62+
- **Prettier** - 代码格式化工具
63+
64+
## 🚀 快速开始
65+
66+
### 环境要求
67+
- Node.js >= 16.0.0
68+
- pnpm >= 7.0.0 (推荐) 或 npm >= 8.0.0
69+
70+
### 安装依赖
71+
72+
```bash
73+
# 使用 pnpm (推荐)
74+
pnpm install
75+
76+
# 或使用 npm
77+
npm install
78+
```
79+
80+
### 开发环境
81+
82+
```bash
83+
# 启动开发服务器
84+
pnpm dev
85+
86+
# 或使用 npm
87+
npm run dev
88+
```
89+
90+
访问 `http://localhost:5173` 即可看到应用运行效果。
91+
92+
### 生产构建
93+
94+
```bash
95+
# 构建生产版本
96+
pnpm build
97+
98+
# 预览生产构建
99+
pnpm preview
100+
```
101+
102+
## 📦 部署指南
103+
104+
### Vercel 部署 (推荐)
105+
1. Fork 本项目到你的 GitHub
106+
2.[Vercel](https://vercel.com) 中导入项目
107+
3. 自动部署完成
108+
109+
### Nginx 部署
110+
```bash
111+
# 构建项目
112+
pnpm build
113+
114+
# 将 dist 目录部署到 Nginx 服务器
115+
# 配置 Nginx 支持 SPA 路由
116+
```
117+
118+
详细部署教程请参考:[部署指南](https://juejin.cn/post/7301193497247727652)
119+
120+
### 解决刷新404问题
121+
参考:[解决vercel项目刷新404问题](https://juejin.cn/post/7358336719165554740)
122+
123+
## 🎮 使用说明
124+
125+
### 基本播放
126+
1. 在播放器中输入视频链接
127+
2. 选择播放器类型(默认播放器 或 ArtPlayer)
128+
3. 点击播放即可开始观看
129+
130+
### 智能跳过设置
131+
1. 点击播放器设置按钮
132+
2. 配置片头跳过时长(默认90秒)
133+
3. 配置片尾跳过时长(默认90秒)
134+
4. 保存设置后自动生效
135+
136+
### 直播功能
137+
1. 点击直播选项卡
138+
2. 选择频道分组
139+
3. 点击频道即可开始观看直播
140+
141+
## 🔧 配置说明
142+
143+
### 播放器配置
144+
```javascript
145+
// 播放器选项配置
146+
const playerOptions = {
147+
hls: {
148+
maxBufferLength: 600,
149+
liveSyncDurationCount: 10,
150+
},
151+
flv: {
152+
enableWorker: false,
153+
enableStashBuffer: false,
154+
autoCleanupSourceBuffer: true,
155+
}
156+
}
157+
```
158+
159+
### CSP 绕过配置
160+
```javascript
161+
// CSP绕过配置
162+
export const CSP_BYPASS_CONFIG = {
163+
enabled: true,
164+
referrerPolicy: 'no-referrer',
165+
autoBypass: true,
166+
autoRetry: true
167+
}
168+
```
169+
170+
## 🤝 贡献指南
171+
172+
我们欢迎所有形式的贡献!请查看 [贡献指南](CONTRIBUTING.md) 了解详细信息。
173+
174+
### 开发流程
175+
1. Fork 本项目
176+
2. 创建特性分支 (`git checkout -b feature/AmazingFeature`)
177+
3. 提交更改 (`git commit -m 'Add some AmazingFeature'`)
178+
4. 推送到分支 (`git push origin feature/AmazingFeature`)
179+
5. 创建 Pull Request
180+
181+
## 📄 许可证
182+
183+
本项目基于 MIT 许可证开源 - 查看 [LICENSE](LICENSE) 文件了解详细信息。
184+
185+
## 🙏 致谢
186+
187+
- [Vue.js](https://vuejs.org/) - 渐进式 JavaScript 框架
188+
- [ArtPlayer](https://artplayer.org/) - 现代化 HTML5 播放器
189+
- [Arco Design](https://arco.design/) - 企业级设计语言
190+
- [Vite](https://vitejs.dev/) - 下一代前端构建工具
191+
192+
## 📞 联系我们
193+
194+
- 项目主页:[https://drplayer.playdreamer.cn/](https://drplayer.playdreamer.cn/)
195+
- 文档站点:[https://hipy.playdreamer.cn/](https://hipy.playdreamer.cn/)
196+
- 问题反馈:[GitHub Issues](https://github.com/your-repo/issues)
197+
198+
---
199+
200+
<div align="center">
201+
202+
**如果这个项目对你有帮助,请给它一个 ⭐️**
203+
204+
Made with ❤️ by DrPlayer Team
205+
206+
</div>
207+
208+
---
209+
210+
## 📚 原始开发笔记
211+
212+
以下是项目开发过程中的技术笔记和参考资料:
213+
214+
### 依赖安装记录
1215
```shell
2216
pnpm create vite
3217
pnpm add primevue primeicons
@@ -14,35 +228,31 @@ pnpm add --save-dev @arco-design/web-vue
14228
pnpm add json-server
15229
pnpm add axios
16230
```
17-
https://juejin.cn/post/7387581121519812617
18231

19-
[arco组件库](https://arco.design/vue/component/layout)
232+
### 技术参考
233+
- [Vue 3 组合式 API 指南](https://juejin.cn/post/7387581121519812617)
234+
- [Arco Design Vue 组件库](https://arco.design/vue/component/layout)
20235

21-
# 注意事项
22-
package.json 需要注意 如果有 type:'module' 需要删除
23-
json-server版本号只能 ^0.17.4,不然不支持middleware
236+
### 注意事项
237+
- package.json 需要注意如果有 `type:'module'` 需要删除
238+
- json-server版本号只能 `^0.17.4`不然不支持middleware
24239

25-
# 图标全选加购
240+
### 实用脚本
241+
图标全选加购脚本:
26242
```javascript
27243
var span = document.querySelectorAll('.icon-cover');
28244
for (var i = 0, len = span.length; i < len; i++) {
29245
console.log(span[i].querySelector('span').click());
30246
}
31-
32247
```
33248

34-
# 部署教程
35-
36-
https://juejin.cn/post/7301193497247727652
37-
38-
[解决vercel项目刷新404问题](https://juejin.cn/post/7358336719165554740)
39-
40-
# 我部署的demo
41-
42-
https://drplayer.playdreamer.cn/
43-
44-
https://hipy.playdreamer.cn/
249+
### 部署相关
250+
- [部署教程](https://juejin.cn/post/7301193497247727652)
251+
- [解决vercel项目刷新404问题](https://juejin.cn/post/7358336719165554740)
45252

46-
# AI加量包购买
253+
### 演示地址
254+
- 主站:[https://drplayer.playdreamer.cn/](https://drplayer.playdreamer.cn/)
255+
- 文档:[https://hipy.playdreamer.cn/](https://hipy.playdreamer.cn/)
47256

48-
[点此访问](https://www.trae.ai/account-setting?purchase=1#usage)
257+
### AI 服务
258+
[AI加量包购买](https://www.trae.ai/account-setting?purchase=1#usage)

0 commit comments

Comments
 (0)