Documentation
Everything You Need to Know

Here's where you'll be able to find out everything about our tool, guides, instructions and more about our services.

Section One: Overview

Here we'll go over the basics, how the tool works, what you'll download and commonly asked questions.

If you're ADHD-prone or just too lazy, we'll include the important stuff in bold to break the content into smaller parts:

Installation

Installation shouldn't be too tricky, but it's important to remember to not have conflicting files. As our tool requires the need to read/write files, other applications doing similiar activities in the same directory, could cause conflictions.

Supported Operating Systems

We support Windows 10, 11 & MacOS (MacOS 14+) (M chips only). Older versons of Windows may be supported, but stability is questioned.

Requirements

There are no requirements to run our software. The software is designed to be as easy as possible to use, only the initial download is required.

What's needed

The only thing you need is your computer and an internet connection, nothing else is required, no further downloads, nothing else. The speed of the tool is dependant on disk speed and internet speed.

Section Two: Integration

In this section, we'll go over specific details on how you can connect the tool to an external software/system such as a Discord webhook/bot

Discord Webhooks/Bots

When you load the tool, you'll be asked if you want to add a Discord webhook or bot. The functionality varies slightly depending on which one you use. A webhook will be able to display output and information about your tool, however you cannot interact with it. A discord bot connection will allow you to interact with the tool through the bot via Discord slash commands and view output.

Other Integrations

If you're savvy enough, you can connect the tool to other systems such as a website or anything you desire. The tool does have some built in aid for this such as connection to a server which you will configure from there. Due to it's complexity, integrations to your own custom system is dependant on yourself.

Adding Integrations

When a connection is added, the tool will output three things, any output file made, time and date, and any errors. To add a connection, go into the 'integration.txt' folder and enter integration details. For discord webhooks, simply put the webhook URL in there. When you load the tool, it should recognise this and display "Inregration: Discord Webhook". If you are adding a custom webhook the tool accepts request URLS, e.g YOURVPSIP/results. From here, its up to you what you want to do with the output.

Integration Plugins

If you want more data to be outputted, we can modify a few things. Firstly, in your 'integrations.txt' the actual URL or webhook link should be on the first line only and any plugins on the following lines an example of a plugin would be "output-key" (outputs the key). Here's a full list of accepted plugins:
output-key
output-logs
output-timeElapsed
output-integrationMethod
output-errorsOnly
output-logInfoOnly
input-allInput
It's important to note that each plugin should be on a unique line after the first (reserved for integration method)