https://github.com/calbabreaker/kontrolbot
Control your computer through discord.
https://github.com/calbabreaker/kontrolbot
bot discord discord-bot javascript nodejs remote-shell shell
Last synced: 10 months ago
JSON representation
Control your computer through discord.
- Host: GitHub
- URL: https://github.com/calbabreaker/kontrolbot
- Owner: Calbabreaker
- License: gpl-3.0
- Created: 2021-07-04T01:19:22.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-08-30T12:36:40.000Z (over 4 years ago)
- Last Synced: 2025-02-12T11:14:30.331Z (12 months ago)
- Topics: bot, discord, discord-bot, javascript, nodejs, remote-shell, shell
- Language: JavaScript
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Kontrol Bot
A cross platform application that allows you to control your computer through
discord using shell commands.
## Setup
#### Getting the bot
First go to the [applications control
panel](https://discord.com/developers/applications), create an application,
then make a bot, then create a .env file with `BOT_TOKEN=put bot token here` as
its contents. Then go to
`http://discord.com/oauth2/authorize?client_id=APP_ID&scope=bot` with APP_ID
being the application ID to add it to a server.
#### Running it
First make sure you have [nodejs](https://nodejs.org/) and
[yarn](https://yarnpkg.com/) installed. Then get the source code of this
repository (by doing `git clone https://github.com/Calbabreaker/kontrolbot/`
or downloading as a zip) and then run `yarn` at the root directory
of the repository.
Now you can run it directly on your computer by running `yarn start`.
You can also run it inside of a docker container by doing `yarn start:docker -t
calbabreaker/kontrolbot`. You can also build a docker image with `yarn
build:docker` and run the image with the same run command but with
calbabreaker/kontrolbot replaced with the built image tag.
## Usage
To send a command, send a message with `>` at the front and it will execute it while sending
back the output. You can use `!kb kill` to kill the current command
although it might not respond if it's stuck in a loop.
By default everyone can use kontrolbot but if you want to restrict usage,
add `OWNERS=` on seperate line in the .env file and add your username#tag
or anyone's username#tag as a comma seperated list to the right of the =.
Example .env:
```
BOT_TOKEN=000000000000000.0000.00000000000000000
OWNERS=User#1013,AmazingUser#2184
```
Now only the specified OWNERS can use kontrol bot. OWNERS can also allow other
people to use kontrol bot by sending `!kb allow username#tag` but that person
they cannot allow others. You can disallow them by doing `!kb disallow username#tag`.
You can also allow or disallow everyone by having the username#tag be `*`.