yuuki/README.md

81 lines
4.1 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-10-19 20:56:42 +08:00
The perfectest LINE Group Protective BOT.
2018-07-24 20:05:34 +08:00
![ICON](logo.png)
2020-10-19 20:56:42 +08:00
This is the BOT which was the first Chinese LINE Group Security BOT.
2020-02-29 14:19:15 +08:00
2020-10-19 21:01:52 +08:00
Since 2018, it turns to be an opensource software.
2018-07-24 20:05:34 +08:00
2020-10-19 20:56:42 +08:00
## Introduction
2020-02-29 14:19:15 +08:00
2020-10-19 20:56:42 +08:00
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.
2018-07-24 20:05:34 +08:00
2020-10-19 20:56:42 +08:00
As know as the group feature of LINE has a major issue, everyone own the permission to modify the member list.
2020-10-19 20:56:42 +08:00
It's a good idea to be fair, but causes a communicate risk if one of member kick everyone maliciously.
2020-10-19 21:01:52 +08:00
So a protective solution is necessary, especially for corporation, organization, or education.
2020-02-29 14:19:15 +08:00
2020-10-19 20:56:42 +08:00
Since 2015, we start to design and provide several solutions to the market and public, Star Yuuki BOT is one of the success cases.
2018-07-24 20:05:34 +08:00
2020-10-19 20:56:42 +08:00
To protect Internet Security is our duty, and open source is romantic, that is why we are here.
2020-02-29 14:19:15 +08:00
2020-10-20 10:52:54 +08:00
> Star Yuuki BOT is designed to be a completed BOT, don't use the software as a "Self BOT", it might damage your account.
2018-07-24 20:05:34 +08:00
2020-10-19 20:56:42 +08:00
## License
2018-07-24 20:05:34 +08:00
2020-10-19 20:56:42 +08:00
The software is licensed under [Mozilla Public License 2.0](LICENSE.md) with [COPYING.md](COPYING.md).
2019-08-22 18:33:10 +08:00
2020-10-19 20:56:42 +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)
2019-08-22 18:33:10 +08:00
2020-10-19 20:56:42 +08:00
## Features
2019-08-22 18:33:10 +08:00
2020-10-20 10:52:54 +08:00
It's a powerful software, not only a BOT, even to be your secretary.
2018-07-24 20:05:34 +08:00
2020-10-19 20:56:42 +08:00
| 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 | X | Preparing |
| 100% [OpenSource](https://github.com/star-inc/star_yuuki_bot) and Free | O | [Licensed](#License) |
2020-02-29 14:19:15 +08:00
2020-10-19 20:56:42 +08:00
## WebAdmin
2020-02-07 20:35:26 +08:00
2020-10-19 20:56:42 +08:00
This is a magic feature since `v6.5.3` that you can control your BOT with GUI.
2019-08-22 18:33:10 +08:00
2020-10-19 20:56:42 +08:00
| Feature | Status | Note |
|---|---|---|
| Broadcast | O | Group Only currently |
| Events Viewer | O |
| Profile Modify | O |
| Groups Management | O |
| Helper Management | O |
| Yuuki Configure | X | Developing |
![WebAdmin](WebAdmin.png)
## Documents
2018-07-24 20:05:34 +08:00
2020-10-19 20:56:42 +08:00
Are you finding how to setup, use, or extend its features?
2020-02-29 14:19:15 +08:00
2020-10-19 20:56:42 +08:00
The documentation is preparing, will be available on [GitHub Wiki](https://github.com/star-inc/star_yuuki_bot/wiki) as soon as possible.
2018-07-24 20:05:34 +08:00
2020-10-19 20:56:42 +08:00
## Logo Copyright
2020-02-29 14:19:15 +08:00
2020-10-19 21:03:13 +08:00
Copyright of `logo.png` belongs to "[©川原 礫ASCII Media WorksSAO Project](https://www.aniplex.co.jp)" and its artists.
2020-02-07 20:35:26 +08:00
2020-10-19 20:56:42 +08:00
> (c) 2020 Star Inc.