From 01b73d4fdebf4183e278acf5d5263cd89189f58b Mon Sep 17 00:00:00 2001 From: Sneexy Date: Wed, 25 Jan 2023 13:19:21 -0600 Subject: [PATCH 1/3] new readme --- README.md | 36 +++++++++++++++++++----------------- 1 file changed, 19 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index eae2c42..ce952f5 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,33 @@ # winbot -A Discord bot for interfacing with a VirtualBox VM. +A Discord bot for interfacing with a QEMU VM. +> Fair warning, this branch is *very* buggy as its pretty much a quick dirty port of the VirtualBox version to QEMU. ## Pre-Setup -1. Install Python 3.8. (If you're able to use `discord.py` with your version of Python 3.9, feel free to use 3.9.) -2. Install VirtualBox. -3. Install `discord.py` and `pywin32` (or your COM library of choice for your platform) -4. Install `virtualbox` by following the instructions at [pypi](https://pypi.org/project/virtualbox/). +1. Install [Python 3](https://www.python.org/downloads/). +2. Install [QEMU](https://www.qemu.org/download/). +3. Install [`discord.py`](https://pypi.org/project/discord.py/) and [`qemu.qmp`](https://pypi.org/project/qemu.qmp/). ## Setup 1. Run `main.py` once. It should generate a new file, `winbot.ini`. -2. Fill out `winbot.ini` with values of your choice. `token` is your Discord bot token, `prefix` is the bot's prefix, `vm_name` is the name of the VM that will be used for the bot, `channel_id` is where the startup message will be sent, and `owner_id` is the ID of the bot owner. -3. Open VirtualBox and create a VM with the same name you used for `vm_name` (if it doesn't already exist. -4. Start the VM through VirtualBox. +2. Fill out `winbot.ini` with values of your choice. `token` is your Discord bot token, `prefix` is the bot's prefix, `channel_id` is where the startup message will be sent, and `owner_id` is the User ID of the bot owner. +3. Start a QEMU VM with `-qmp tcp:localhost:4444,server,nowait` appended to the end of it's launch options. 5. Start the bot by running `main.py`. 6. Go nuts! +> Note: You can ignore `vm_name` safely as it is no longer needed, unless you are running multiple QMP enabled QEMU instances at once. ## Commands ``` - help Shows this message - keys Get a list of keys you can use with press - mouse Do mouse shit. - ping Ping Pong! - press Send special keys to the VM. - reload Reload the bot config files. - reset Reset the VM. Owner only. - screen Get a screenshot of the VM. - type Sends a long string of text to the VM, followed by a newline. + backspace Really fuckin delete something. + help Shows this message. + keys Get a list of keys you can use with vb!press + mouse Control the mouse. + ping Ping Pong! + press Send special keys to the VM. + raw_command Send raw QEMU inputs. + reload Reload winbot's config file. + reset Reset the VM. Owner only. + screen Get a screenshot of the VM. + type Sends a long string of text to the VM, followed by a newline. ``` Run `help [command name]` for more info on each command. From b768761349c90ef8cd9e178d6837a466d7e4a7cd Mon Sep 17 00:00:00 2001 From: Sneexy Date: Wed, 25 Jan 2023 13:44:16 -0600 Subject: [PATCH 2/3] slight text and grammer changes --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ce952f5..554e2f7 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # winbot A Discord bot for interfacing with a QEMU VM. -> Fair warning, this branch is *very* buggy as its pretty much a quick dirty port of the VirtualBox version to QEMU. +> Fair warning, this branch is *very* buggy as it's pretty much a quick dirty port of the VirtualBox version to QEMU. ## Pre-Setup 1. Install [Python 3](https://www.python.org/downloads/). @@ -9,8 +9,8 @@ A Discord bot for interfacing with a QEMU VM. ## Setup 1. Run `main.py` once. It should generate a new file, `winbot.ini`. -2. Fill out `winbot.ini` with values of your choice. `token` is your Discord bot token, `prefix` is the bot's prefix, `channel_id` is where the startup message will be sent, and `owner_id` is the User ID of the bot owner. -3. Start a QEMU VM with `-qmp tcp:localhost:4444,server,nowait` appended to the end of it's launch options. +2. Fill out `winbot.ini` with values of your choice. `token` is your Discord bot token, `prefix` is the bot's prefix, `channel_id` is the Text Channel ID of where the bot's startup message will be sent and `owner_id` is the User ID of the bot's owner. +3. Start a QEMU VM with `-qmp tcp:localhost:4444,server,nowait` appended to the end of its launch options. 5. Start the bot by running `main.py`. 6. Go nuts! > Note: You can ignore `vm_name` safely as it is no longer needed, unless you are running multiple QMP enabled QEMU instances at once. From cc159e42119b7a5f89899c89ba3ce8cf27a6698d Mon Sep 17 00:00:00 2001 From: Sneexy Date: Wed, 25 Jan 2023 14:07:37 -0600 Subject: [PATCH 3/3] one final fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 554e2f7..fd62354 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ A Discord bot for interfacing with a QEMU VM. ``` backspace Really fuckin delete something. help Shows this message. - keys Get a list of keys you can use with vb!press + keys Get a list of keys you can use with the 'press' command. mouse Control the mouse. ping Ping Pong! press Send special keys to the VM.