https://github.com/Workbench-Team/natsuki-ggproject
Natsuki is a discord bot of GG project
https://github.com/Workbench-Team/natsuki-ggproject
backend bot dedicated discord discord-bot discord-music-bot discordapp discordbot discordia lit lua luvi luvit natsuki privileges under-construction under-development
Last synced: 2 months ago
JSON representation
Natsuki is a discord bot of GG project
- Host: GitHub
- URL: https://github.com/Workbench-Team/natsuki-ggproject
- Owner: Workbench-Team
- License: gpl-3.0
- Archived: true
- Created: 2019-12-02T18:28:27.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-02-23T02:04:41.000Z (about 4 years ago)
- Last Synced: 2024-07-29T19:13:27.303Z (10 months ago)
- Topics: backend, bot, dedicated, discord, discord-bot, discord-music-bot, discordapp, discordbot, discordia, lit, lua, luvi, luvit, natsuki, privileges, under-construction, under-development
- Language: Lua
- Homepage: https://ggproject.xyz/discord
- Size: 2.52 MB
- Stars: 3
- Watchers: 5
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Natsuki Discord bot
Natsuki is a discord bot of GG project and dedicated firstly for GG project
Some modules need to rewrite to work with configs and be adaptive for any bot
### GG project info
The project is dedicated to creating unique servers on the Internet. Of course, all servers can be unique, but we try to make them as unique and interesting as possible.
# Features
- Read and reply DM
- Simple command handler
- Embed generator
- Privileges (need to rewrite)
- Read `modules/list.lua` to know all features
### TODO
- New privileges system
- Votes for GG Events
- Automatic check reviews of GG Project
- Rewrite voice module for any stream and playing music
- Archive of appelas of GG project
- Command to give clan roles for clan owners of GG project
- Write all servers where bot is
- Translation to other languages
## Install and config
### Install and launch
```sh
$ git clone https://github.com/GG-Project/natsuki.git
$ cd natsuki/
$ luvit natsuki.lua
```
### Dependencies
To launch bot you need [discordia](https://github.com/SinisterRectus/discordia) library, that works on [luvit](http://luvit.io). Just follow instructions on discordia repository, how to install it
### Configs
Before launch bot, create `config.json` in home folder and config token for it:
```json
{
"token": "Token of your discord bot",
"example_backend_url": "http://127.0.0.1:1080/api/"
}
```
Other configs in that `config.json` requires with some modules
To disable some modules you need to comment lines in `modules/list.lua`
Configs, that allows to use some modules:
Configs | Config description | Allowed modules
--- | --- | ---
`backend_url`, `backend_token` | Use [backend](https://github.com/GG-Project/backend) | `admin`, `privileges`, `accounts_link`
`qiwi_hook_id` | Qiwi donate notifier. DEPRECATED | `qiwidonat`
`economy_smile`, `economy_curse_in` | Economy valute emoji and curse. DEPRECATED | `economy`
`donation_channel_id` | Notify to specified channel id about donate. DEPRECATED | `money`
### Privileges
`groups.lua` config for `admin` module:
```lua
groups = {
['discord_user_id'] = 'owner',
['other_discord_user_id'] = 'admin'
}
```
## Backend
To work with backend, you need to config and launch backend server from [this repository](https://github.com/GG-Project/backend)
### Config
Just create `config.json` with following configs:
```json
{
"listen_port": "backend server port",
"tokens": ["backend token 1", "backend token 2", "and more tokens"],
"privilege_servers": ["server_name_1", "server_name_2"],
"mysql_db_host": "database_remote_ip",
"mysql_db_port": 3306,
"mysql_db_user": "database_user",
"mysql_db_password": "database_user_password",
"mysql_db_name": "database_name"
}
```
### Launch
```sh
$ cd backend/
$ luvit http.lua
```
# License
[GNU General Public License v3.0](https://github.com/ProfessorBrain/natsuki/blob/master/LICENSE)