yuuki/README.md

63 lines
2.7 KiB
Markdown
Raw Normal View History

2020-02-29 14:19:15 +08:00
# Star Yuuki(pYthon) BOT - Yuuki
2020-01-29 14:53:39 +08:00
![Version](https://img.shields.io/badge/v6.5.3-OpenSource-FF0033.svg) ![Series](https://img.shields.io/badge/syb-Series-7700FF.svg) ![License](https://img.shields.io/badge/license-MPL--2.0-FF6600.svg) ![Python](https://img.shields.io/badge/python-3.x-0066FF.svg) ![Platform](https://img.shields.io/badge/base_on-LINE-00DD00.svg)
2020-07-23 20:22:56 +08:00
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/star-inc/star_yuuki_bot/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/star-inc/star_yuuki_bot/?branch=master) [![Build Status](https://scrutinizer-ci.com/g/star-inc/star_yuuki_bot/badges/build.png?b=master)](https://scrutinizer-ci.com/g/star-inc/star_yuuki_bot/build-status/master) [![Code Intelligence Status](https://scrutinizer-ci.com/g/star-inc/star_yuuki_bot/badges/code-intelligence.svg?b=master)](https://scrutinizer-ci.com/code-intelligence)
[![Total alerts](https://img.shields.io/lgtm/alerts/g/star-inc/star_yuuki_bot.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/star-inc/star_yuuki_bot/alerts/) [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/star-inc/star_yuuki_bot.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/star-inc/star_yuuki_bot/context:python)
2020-07-23 19:54:49 +08:00
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fstar-inc%2Fstar_yuuki_bot.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fstar-inc%2Fstar_yuuki_bot?ref=badge_shield)
2018-07-24 20:05:34 +08:00
2020-02-07 20:35:26 +08:00
A Python BOT for LINE Group Protection.
2018-07-24 20:05:34 +08:00
![ICON](logo.png)
## Maybe you had seen it !
2020-02-29 14:19:15 +08:00
2018-07-24 20:05:34 +08:00
Yeah! This is the BOT which was the first Chinese LINE Group Security BOT.
Now, it is OpenSource.
## License
2020-02-29 14:19:15 +08:00
2019-10-14 21:52:14 +08:00
The software licensed under [Mozilla Public License 2.0](LICENSE.md) with [COPYING.md](COPYING.md).
2018-07-24 20:05:34 +08:00
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fstar-inc%2Fstar_yuuki_bot.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fstar-inc%2Fstar_yuuki_bot?ref=badge_large)
2018-07-24 20:05:34 +08:00
## Warning
2020-02-29 14:19:15 +08:00
2019-08-22 18:33:10 +08:00
Some function of old version maybe will make your LINE account be banned.
2018-07-24 20:05:34 +08:00
2019-08-22 19:12:13 +08:00
## Requirement
2020-02-29 14:19:15 +08:00
2019-12-27 21:58:00 +08:00
Recommend Environment:
2018-07-24 20:05:34 +08:00
2019-08-22 18:33:10 +08:00
Ubuntu >= 18.04
python >= 3.7
pip >= 19.2
2019-10-14 20:40:20 +08:00
git >= 2.17
2018-07-24 20:05:34 +08:00
2019-08-31 23:32:32 +08:00
## Setup
2019-08-22 18:33:10 +08:00
2020-02-29 14:19:15 +08:00
+ Check your system environment(Operating System, Requirements...)
2019-08-22 18:33:10 +08:00
2020-02-29 14:19:15 +08:00
+ Execute:
2019-08-22 18:33:10 +08:00
2020-02-29 14:19:15 +08:00
`pip install -Ur requirements.txt`
2018-07-24 20:05:34 +08:00
## Usage
2020-02-29 14:19:15 +08:00
2020-02-07 20:35:26 +08:00
+ Copy `config.yaml` from `config.sample.yaml`
+ Configure your settings and environment in `config.yaml`
2019-08-22 18:33:10 +08:00
2020-02-29 14:19:15 +08:00
+ Execute:
2019-08-22 18:33:10 +08:00
2020-02-29 14:19:15 +08:00
`python main.py`
2018-07-24 20:05:34 +08:00
2019-08-22 18:33:10 +08:00
## Old Version
2020-02-29 14:19:15 +08:00
Maybe you want the source of history version. [Click me](https://github.com/star-inc/star_yuuki_bot/releases/tag/old-versions)
2018-07-24 20:05:34 +08:00
### Logo Copyright
2020-02-29 14:19:15 +08:00
2019-09-01 12:26:50 +08:00
Copyright of the Image which was named "logo.png" belongs to "[©川原 礫ASCII Media WorksSAO Project](https://www.aniplex.co.jp)".
2020-02-07 20:35:26 +08:00
> (c) 2020 Star Inc.