yuuki/README.md

# Star Yuuki(pYthon) BOT - Yuuki

![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)

[![Scrutinizer-CI_Build](https://scrutinizer-ci.com/g/star-inc/star_yuuki_bot/badges/build.png?b=master) ![Scrutinizer-CI_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/) 
[![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)

A Python BOT for LINE Group Protection.
![ICON](logo.png)

## Maybe you had seen it !

Yeah! This is the BOT which was the first Chinese LINE Group Security BOT.
Now, it is OpenSource.

## License

The software licensed under [Mozilla Public License 2.0](LICENSE.md) with [COPYING.md](COPYING.md).


[![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)

## Warning

Some function of old version maybe will make your LINE account be banned.

## Requirement

Recommend Environment:

    Ubuntu >= 18.04
    python >= 3.7
    pip >= 19.2
    git >= 2.17

## Setup

+ Check your system environment(Operating System, Requirements...)

+ Execute:

    `pip install -Ur requirements.txt`

## Usage

+ Copy `config.yaml` from `config.sample.yaml`

+ Configure your settings and environment in `config.yaml`

+ Execute:

    `python main.py`

## Old Version

Maybe you want the source of history version. [Click me](https://github.com/star-inc/star_yuuki_bot/releases/tag/old-versions)

### Logo Copyright

Copyright of the Image which was named "logo.png" belongs to "[©川原 礫／ASCII Media Works／SAO Project](https://www.aniplex.co.jp)".

> (c) 2020 Star Inc.