# SPlayer

**Repository Path**: mirrors/SPlayer

## Basic Information

- **Project Name**: SPlayer
- **Description**: 射手影音播放器是由射手网创建与维护的开源播放器项目
- **Primary Language**: C/C++
- **License**: GPL-3.0
- **Default Branch**: develop
- **Homepage**: https://www.oschina.net/p/splayer
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2020-04-24
- **Last Updated**: 2025-09-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# SPlayer
[![Dependencies Status](https://david-dm.org/chiflix/splayerx/develop/status.svg)](https://david-dm.org/chiflix/splayerx/develop/)
[![devDependencies Status](https://david-dm.org/chiflix/splayerx/develop/dev-status.svg)](https://david-dm.org/chiflix/splayerx/develop?type=dev)
[![Build Status](https://travis-ci.org/chiflix/splayerx.svg?branch=develop)](https://travis-ci.org/chiflix/splayerx?branch=develop)
[![appveyor](https://ci.appveyor.com/api/projects/status/github/chiflix/splayerx?branch=develop&svg=true)](https://ci.appveyor.com/project/tomasen/splayerx/branch/develop)
[![codecov](https://codecov.io/gh/chiflix/splayerx/branch/develop/graph/badge.svg)](https://codecov.io/gh/chiflix/splayerx/branch/develop)
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/splayerx/localized.svg)](https://crowdin.com/project/splayerx)

### 开发指南

目前架构的特点在 Electron 的基础上使用了 [Vue.js](https://vuejs.org/) MVVM组件化开发框架。

- 开发中使用 webpack，运行 `npm run dev` 修改代码后可以同步至表现层，hot reload，不用重新启动。
- 使用 eslint 控制代码质量，不满足标准的代码无法通过编译并会报错。
- 每次版本提交会通过 travis-ci 和 appveyor 自动编译，如果不能通过编译会记录错误，且相应的 badge会变红色。
- 当 [tag](https://github.com/chiflix/video-player/releases/new) 一个新的commit时，CI 工具会自动打包发行版本，并放入 [GitHub Releases](https://github.com/chiflix/splayerx/releases)。
- 使用 Karma 进行单元测试，codecov的badge [![codecov](https://codecov.io/gh/chiflix/splayerx/branch/develop/graph/badge.svg)](https://codecov.io/gh/chiflix/splayerx/branch/develop)
 会显示当前代码的测试覆盖率。
- 使用 [Global Event Bus](https://alligator.io/vuejs/global-event-bus/) 做消息通讯
- 使用 [vue-router](https://router.vuejs.org/en/) 和 [vuex](https://vuex.vuejs.org/en/intro.html) 用于跨组件数据交互。
- 有可能导致阻塞的操作，例如IO读写或者CPU intensive tasks，应放在基于 electron-remote 创建的 separate process 里面。参考：[Deep dive into Electron’s main and renderer processes](https://medium.com/cameron-nokes/deep-dive-into-electrons-main-and-renderer-processes-7a9599d5c9e2)
- 可以用 CommandOrControl+Shift+I+O+P 打开开发工具，在 production 环境中也可以使用

#### 注意事项

- 代码风格遵循 https://vuejs.org/v2/style-guide/ ，命名使用 PascalCase 风格
- commit message 遵循 AngularJS Git Commit Message Conventions，提交需通过 [CommitLint Online](https://commitlint.io/) 检查。
- 播放事件的生命周期：
> 1. 通过Global Event Bus `this.$bus` 发出指令，例如 play、pause
> 2. VideoCanvas 收到 event 之后，调用 DOM 的 function 控制 video 对象
> 3. video 对象的事件会绑定至 VideoCanvas 的 methods
> 4. 消息中的状态数据通过 vuex commit 至 `this.$store` 中
> 5. 其他各 vue components 根据 data store 的数据状态更新表现层
- video-controller 之下的 child components 需要响应 click 事件时注意使用 `v-on:click.capture.stop` 以保证先于 video-controller 触发点击事件并避免事件穿透
- 代码引用文件时使用 `~@/` 代表代码根目录，例如 `src="~@/assets/"`
- 字体文件放在fonts目录下，css|scss文件放在css目录下
- 使用 vue-i18n 做多语言支持
- 优先使用CSS来制作动态效果

#### Branching Model

- http://nvie.com/posts/a-successful-git-branching-model/

#### Build

``` bash
# install dependencies
npm install

# serve with hot reload at localhost:9080
npm run dev

# build electron application for production
npm run build

# run unit test
npm run unit

# lint all JS/Vue component files in `src/`
npm run lint
```

#### Publish

in `.travis.yml`
- CSC_LINK and CSC_KEY_PASSWORD from https://www.electron.build/code-signing/
- GH_TOKEN= https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/

#### Maintainance Cheetsheet

clear up AppVeyor Cache
```
export APPVEYOR_TOKEN="<your-api-token>"
curl -H "Authorization: Bearer $APPVEYOR_TOKEN" -H "Content-Type: application/json" -X "DELETE" \ https://ci.appveyor.com/api/projects/tomasen/splayerx-susim/buildcache
```

---

This project was generated with [electron-vue](https://github.com/SimulatedGREG/electron-vue)@[7c4e3e9](https://github.com/SimulatedGREG/electron-vue/tree/7c4e3e90a772bd4c27d2dd4790f61f09bae0fcef) using [vue-cli](https://github.com/vuejs/vue-cli). Documentation about the original structure can be found [here](https://simulatedgreg.gitbooks.io/electron-vue/content/index.html).