# ratel-client

**Repository Path**: flymyd/ratel-client

## Basic Information

- **Project Name**: ratel-client
- **Description**: 斗地主网页客户端
- **Primary Language**: JavaScript
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 1
- **Created**: 2022-05-05
- **Last Updated**: 2023-06-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## js-ratel-client

[![](https://img.shields.io/badge/license-Apache-blue)]() [![build status](https://img.shields.io/badge/build-passing-brightgreen)]() [![](https://img.shields.io/badge/javascript-%3E%3D%20ES6-brightgreen)]()

`js-ratel-client` 是一款运行在浏览器上的[ratel](https://github.com/ainilili/ratel)客户端。此客户端对原先的`ratel-client`功能进行了100%还原。

并且与其他客户端相比，其具有以下特点：

1. 使用更加简单，无需下载编译客户端，最简便的方式仅仅是输入一个网址即可使用
2. 页面更加友好，借助`html` + `css`的强大渲染能力下，我们对展示界面进行了一些优化
3. 更好的隐蔽性，我们在页面上嵌入了百度等网页，你可以边打牌边假装查资料
4. 支持自定义化配置，打造你的专属页面
5. 支持聊天功能，聊天消息以'~'开头

另外需要强调的是：虽然此客户端使用`websocket`协议进行通信，但是可以和其他客户端用户一起游戏

> 此项目的桌面版本[electronjs-ratel-client](https://github.com/marmot-z/electronjs-ratel-client.git)


### Install

#### 下载

```shell
git clone https://github.com/marmot-z/js-ratel-client.git
cd js-ratel-client
```

#### 部署

1. 直接双击`index.html`使用浏览器打开页面进行游戏
2. 或者部署在`tomacat`、`jetty`等应用服务器或者`nginx`代理服务器上，可提供外部访问进行游戏
3. 或者访问 [http://ratel.isnico.com](http://ratel.isnico.com) 进行游戏


### Usage

请看 [使用介绍](./usage.md)

### Roadmap

- 更友善的页面
  - 使用`css`优化页面显示
- 自定义配置，定制用户页面
  - 自定义嵌入页面，不仅仅是百度
  - 显示/隐藏 快捷键设置
  - 背景，字体自定义
- 浏览器兼容
- 用户聊天


### Contribution

- 如果你有发现什么问题请提[ISSUE](https://github.com/marmot-z/js-ratel-client/issues)
- 如果你有好的想法，欢迎提供[PR](https://github.com/marmot-z/js-ratel-client/pulls)
- 如果觉得有帮助，请给作者点个 :star: 吧，秋梨膏