[](https://codecov.io/gh/JavaCS3/xterm-player)
[](https://www.npmjs.com/package/xterm-player)
[](https://www.npmjs.com/package/xterm-player)
[](https://www.jsdelivr.com/package/npm/xterm-player)
[](https://gitter.im/xterm-player/community)
# XtermPlayer [中文文档](./README.zh.md)
This repo is intended to provide an alternative asciinema player. The original [player](https://github.com/asciinema/asciinema-player) is writtern in `ClojureScript`. I think it's hard for frontend people to contribute that directly. This project is intended to make it easier for people to contribute by using `Typescript`.
## [Demo](https://javacs3.github.io/xterm-player/)
## Usage
```html
```
## Features
1. Support orginal 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) format and features
2. Support [Terminalizer](https://github.com/faressoft/terminalizer-player) format
3. Support Audio
## FAQ
### How to record terminal session with audio
```shell
$ npm i -g xterm-recorder # install xterm-recorder first
$ xterm-recorder rec # exit terminal session will automatically save your recording to out.cast
```
check peer project https://github.com/JavaCS3/xterm-recorder for details
### How to customize theme
Here is a solarized dark example
```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 })
```
## Develop Guide
```shell
$ cd && yarn
$ yarn demo
$ yarn test
```