# XtermPlayer
本项目的设计初衷是提供`asciinema-player`的替代品。[asciinema-player](https://github.com/asciinema/asciinema-player)
是用`ClojureScript`实现的，我认为这门语言过于小众，大部分前端工程师很难直接参与贡献。
因此本项目希望利用`Typescript`让项目的贡献变得简单一点。
当然还远不止这些！
## [Demo展示](https://javacs3.github.io/xterm-player/)
## 使用方法
```html
```
## 功能特色
1. 支持 asciinema [v1](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v1.md), [v2](https://github.com/asciinema/asciinema/blob/develop/doc/asciicast-v2.md) 文件格式和功能
2. 支持 [Terminalizer](https://github.com/faressoft/terminalizer-player) 文件格式
3. 支持嵌入音频
## 常见问题
### 如何录制一个带有声音的终端录屏
```shell
$ npm i -g xterm-recorder # 首先安装 xterm-recorder
$ xterm-recorder rec # 进程退出后会自动保存至 out.cast
```
更多使用方法请查阅 https://github.com/JavaCS3/xterm-recorder
### 如何自定义主题
这里是一个 solarized dark 主题的例子
```javascript
const solarized_dark_theme = {
background: '#002b36',
foreground: '#839496',
cursor: '#839496',
cursorAccent: '#839496',
selection: '#073642',
black: '#073642',
brightBlack: '#002b36',
blue: '#268bd2',
brightBlue: '#839496',
red: '#dc322f',
brightRed: '#cb4b16',
green: '#859900',
brightGreen: '#586e75',
yellow: '#b58900',
brightYellow: '#657b83',
magenta: '#d33682',
brightMagenta: '#6c71c4',
cyan: '#2aa198',
brightCyan: '#93a1a1',
white: '#eee8d5',
brightWhite: '#fdf6e3',
}
const player = new XtermPlayer.XtermPlayer(url, div, { theme: solarized_dark_theme })
```
## 如何开发
```shell
$ cd && yarn
$ yarn demo
$ yarn test
```