Add README.MD, LICENSE, and config.example.json. Format with prettier

This commit is contained in:
Elijah R 2024-06-25 16:40:58 -04:00
parent 050b670f77
commit eb5beb3e56
5 changed files with 53 additions and 2 deletions

7
LICENSE Normal file
View file

@ -0,0 +1,7 @@
Copyright 2024 Computernewb Development Team
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

10
README.MD Normal file
View file

@ -0,0 +1,10 @@
# AnyOSInstallBot
The bot that powers VM7 and VM8 (The Install any OS VMs) on CollabVM.
## Running
1. Copy `config.example.json` to `config.json` and fill out fields
2. Install dependencies: `yarn`
3. Build the source: `yarn build`
4. Run it: `node dist/index.js`

28
config.example.json Normal file
View file

@ -0,0 +1,28 @@
{
"BANNED_ISO": [],
"ISO_DIRECTORIES": {
"computernewb": "/srv/data/iso",
"lily": "/home/lily/www/ISOs",
"crustywin": "/srv/data/crustywindows"
},
"INSTALLBOT_VMS": [
{
"uri": "wss://computernewb.com/collab-vm/vm7",
"id": "vm7",
"usesIde2": false,
"hasFloppy": true,
"hasUsb": true
},
{
"uri": "wss://computernewb.com/collab-vm/vm8",
"id": "vm8",
"usesIde2": false,
"hasFloppy": true,
"hasUsb": true
}
],
"BOT_PREFIX": "!",
"ADMIN_TOKEN": "get_your_own_bot_token",
"kGeneralLimitBaseSeconds": 6,
"kRebootLimitBaseSeconds": 25
}

View file

@ -4,7 +4,7 @@
"description": "Helper bot to insert media into AnyOS VMs", "description": "Helper bot to insert media into AnyOS VMs",
"main": "index.js", "main": "index.js",
"author": "Computernewb", "author": "Computernewb",
"license": "ISC", "license": "MIT",
"type": "module", "type": "module",
"dependencies": { "dependencies": {
"ws": "^8.3.0" "ws": "^8.3.0"

View file

@ -109,7 +109,13 @@ class HelperBot extends CollabVMClient {
private GeneralCmdLimit: RateLimit | undefined; private GeneralCmdLimit: RateLimit | undefined;
private RebootLimit: RateLimit | undefined; private RebootLimit: RateLimit | undefined;
constructor(wsUri: string, vmId: string, ide2: boolean, floppy: boolean, usb: boolean) { constructor(
wsUri: string,
vmId: string,
ide2: boolean,
floppy: boolean,
usb: boolean,
) {
super(); super();
this._wsUri = wsUri; this._wsUri = wsUri;