# Star Yuuki(pYthon) BOT - Yuuki

<<<<<<< HEAD
![Version](https://img.shields.io/badge/v8-OpenSource-FF0033.svg)
=======
> v6 receives security updates only, no feature will be added.

![Version](https://img.shields.io/badge/v6.5.3-OpenSource-FF0033.svg)
>>>>>>> v6
![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 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)
[![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)

The perfectest LINE Group Protective BOT.

![ICON](logo.png)

This is the BOT which was the first Chinese LINE Group Security BOT.

Since 2018, it turns to be an opensource software.

## Introduction

<<<<<<< HEAD
Version `v8` is not ready.
=======
This is a LINE Group Security BOT, to solve the problem that prevent from someone who is not the management but trying to destroy the group.

As know as the group feature of LINE has a major issue, everyone own the permission to modify the member list.

It's a good idea to be fair, but causes a communicated risk if one of member kick everyone maliciously.

So a protective solution is necessary, especially for corporation, organization, or education.

Since 2015, we start to design and provide several solutions to the market and public, Star Yuuki BOT is one of the success cases.

To protect Internet Security is our duty, and open source is romantic, that is why we are here.

> Star Yuuki BOT is designed to be a completed BOT, don't use the software as a "Self BOT", it might damage your account.

## License

The software is 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)

## Features

It's a powerful software, not only a BOT, even to be your secretary.

| Feature | Status |  Note |
|---|---|---|
| Login for authorizing | X | [Read the document](https://github.com/star-inc/star_yuuki_bot/wiki/Configure) |
| Basic Group Protection | O |
| Specify the Vice Administrators of a Group | O |
| Multiprocessing Support | O |
| Advanced Group Protection | O |
| [WebAdmin](#WebAdmin) | O |
| General [Manual](https://line.starinc.xyz/yuuki_manual/) for Users | O |
| [Documentation](#Documents) for Developers | O |
| 100% [OpenSource](https://github.com/star-inc/star_yuuki_bot) and Free | O | [Licensed](#License) |

## WebAdmin

This is a magic feature since `v6.5.3` that you can control your BOT with GUI.

| Feature | Status |  Note |
|---|---|---|
| Broadcast | O | Group only currently |
| Events Viewer | O |
| Profile Modify | O |
| Groups Management | O |
| Helper Management | O |
| Yuuki Configure | X | Will be available in v8 |

![WebAdmin](WebAdmin.png)

## Documents

Are you finding how to set up, configure, and use it, or extend its features? 

The documentation for developers is available on [GitHub Wiki](https://github.com/star-inc/star_yuuki_bot/wiki).

Welcome to help us for improving and making `Yuuki` better!
>>>>>>> v6

## Logo Copyright

Copyright of `logo.png` belongs to "[©川原 礫／ASCII Media Works／SAO Project](https://www.aniplex.co.jp)" and its artists.

> (c) 2021 Star Inc.