mirror of
https://github.com/star-inc/star_yuuki_bot.git
synced 2024-09-20 06:46:17 +08:00
Update documents and index.html of WA
This commit is contained in:
parent
914ddc8482
commit
530c302e9a
13
COPYING.md
13
COPYING.md
|
@ -4,17 +4,18 @@
|
|||
License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
||||
|
||||
1)You can edit/copy these files, but you need to keep the original "[COPYING.md](COPYING.md)", "[LICENSE.md](LICENSE.md)" and in the program which you did it.
|
||||
+ You can edit/copy these files, but you need to keep the original "[COPYING.md](COPYING.md)", "[LICENSE.md](LICENSE.md)" and in the program which you did it.
|
||||
|
||||
2)The copyright of [Line Services](https://line.starinc.xyz/) contents belongs to [Star Inc.](https://starinc.xyz)
|
||||
+ The copyright of [LINE Services](https://line.starinc.xyz/) contents belongs to [Star Inc.](https://starinc.xyz)
|
||||
|
||||
3)Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||
+ Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
|
||||
|
||||
4)If your using cause any legal problem, we DO NOT assume any responsibility.
|
||||
+ If your using cause any legal problem, we DO NOT assume any responsibility.
|
||||
|
||||
+ Enjoy using ;)
|
||||
|
||||
5)Enjoy using ;)
|
||||
|
||||
This Source Code Form is "Incompatible With Secondary Licenses", as
|
||||
defined by the Mozilla Public License, v. 2.0.
|
||||
|
||||
Copyright 2019 [Star Inc.](https://starinc.xyz) All Rights Reserved.
|
||||
> Copyright(c) 2020 [Star Inc.](https://starinc.xyz) All Rights Reserved.
|
||||
|
|
84
README.md
84
README.md
|
@ -6,24 +6,66 @@
|
|||
[![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)
|
||||
|
||||
A Python BOT for LINE Group Protection.
|
||||
The perfectest LINE Group Protective BOT.
|
||||
|
||||
![ICON](logo.png)
|
||||
|
||||
## Maybe you had seen it !
|
||||
This is the BOT which was the first Chinese LINE Group Security BOT.
|
||||
|
||||
Yeah! This is the BOT which was the first Chinese LINE Group Security BOT.
|
||||
Now, it is OpenSource.
|
||||
Since 2018, it turns to an opensource software.
|
||||
|
||||
## Introduction
|
||||
|
||||
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 communicate risk if one of member kick everyone maliciously.
|
||||
|
||||
So a protective solution is necessary, especially for commerce, corporation, even Youtuber.
|
||||
|
||||
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.
|
||||
|
||||
> This is design to be a complete BOT, don't use the software as a "Self BOT", it might damage your account.
|
||||
|
||||
## License
|
||||
|
||||
The software licensed under [Mozilla Public License 2.0](LICENSE.md) with [COPYING.md](COPYING.md).
|
||||
|
||||
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)
|
||||
|
||||
## Warning
|
||||
## Features
|
||||
|
||||
Some function of old version maybe will make your LINE account be banned.
|
||||
It's a powerful software, not only a BOT, even to be you 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 | X | Preparing |
|
||||
| 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 | Developing |
|
||||
|
||||
![WebAdmin](WebAdmin.png)
|
||||
|
||||
## Requirement
|
||||
|
||||
|
@ -34,30 +76,14 @@ Recommend Environment:
|
|||
pip >= 19.2
|
||||
git >= 2.17
|
||||
|
||||
## Setup
|
||||
## Documents
|
||||
|
||||
+ Check your system environment(Operating System, Requirements...)
|
||||
Are you finding how to setup, use, or extend its features?
|
||||
|
||||
+ Execute:
|
||||
The documentation is preparing, will be available on [GitHub Wiki](https://github.com/star-inc/star_yuuki_bot/wiki) as soon as possible.
|
||||
|
||||
`pip install -Ur requirements.txt`
|
||||
## Logo Copyright
|
||||
|
||||
## 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)".
|
||||
The copyright of `logo.png` belongs to "[©川原 礫/ASCII Media Works/SAO Project](https://www.aniplex.co.jp)" and its artists.
|
||||
|
||||
> (c) 2020 Star Inc.
|
BIN
WebAdmin.png
Normal file
BIN
WebAdmin.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 78 KiB |
|
@ -39,8 +39,8 @@
|
|||
|
||||
<!-- Optional JavaScript -->
|
||||
{{ bootstrap.load_js() }}
|
||||
<script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/vue-router/dist/vue-router.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/vue/dist/vue.min.js"></script>
|
||||
<script src="https://cdn.jsdelivr.net/npm/vue-router/dist/vue-router.min.js"></script>
|
||||
<script type="module" src="{{ url_for('static', filename='js/main.js') }}"></script>
|
||||
</body>
|
||||
|
||||
|
|
Loading…
Reference in a new issue