Skip to content

MADMAN-Modding/FalconsEsportsOverlays

Repository files navigation

FalconsEsportsOverlays

This is a streaming overlay for esports teams with a nice gui app written in dart, you can it find in the releases page. There is also a web controlled version but that is only for releases 2.1.4 and below. Everything marked legacy has been replaced by the app.

Setup

Using the App (Highly recommended)

Go to the latest release on the releases tab, download the zip file for your respective OS, unzip the file, make sure that you keep everything in that folder together, git must be installed in order to download the actual overlays, the homepage of the app will explain the rest.

Clone/update with git cli

Git (optional but recommended)

Installing git makes it easier to update the cloned code when the project it updated. Download git from here. Get the version for your machine, most likely it will be 64-bit. Run the .exe and just go through the menus, the default options will be fine for this. Or if you're on Linux just install in with your package manager ex:(sudo yay -Sy git or sudo apt install git)

Cloning the Repository

Go to the Overlay Files page on the controller to download the files

Docker (Legacy)

Get the docker here

I (MADMAN-Modding) usually update the docker every release, but it will still pull from main every time it starts. There is no currently no support for the docker from the dart app.

PHP Setup (Legacy)

Windows

PHP

Installing PHP is a bit of an inaccuracy, on Windows all you have to do is download it. I recommend getting the .zip of the non thread safe. Once downloaded, extract the .zip file by right-clicking and press extract all. Now you can move this to whatever folder you want, or not, it doesn't matter.

Adding PHP to the PATH (optional but recommended)

Open the system environment variables by typing environmental into the Windows search bar and pressing enter, it should open the correct menu.

An image of searching for environmental variables settings

Now click on the "Environmental Variables" button in the bottom right of the menu.

Environmental variables step2

We're almost done with this part, now select PATH and press edit

An image opening the environmental variables configuration

Now just press new and type the path of the folder you are keeping the php files, if there are space than surround the path with quotes.

A image of adding a environmental variable

Now you should be all set to continue on with setup.

Getting the code without git installed

Go to the main page of the project. Press the code button above and to the right of the files displayed, then press download zip. Just extract that folder to the folder you will be keeping the project.

Running the PHP server

Open up Powershell or CMD, I personally use Powershell because I prefer it, cd into the directory that holds the code, cd to where you are storing the project.

cd "C:\Path\to\your\data"

Before starting the server get your ip so other devices can use the website

ipconfig

Look for the line that says ipv4 and copy the ip from there, if it doesn't look the example I supplied that's ok. In this test virtual machine the ip I would use is 10.0.0.120

Ipconfig output image

If you have added php to the PATH run the first command, if you chose to not add PHP to the PATH than run the second command. (You can replace the ip-address with localhost if you choose but it will only work on that machine)

php -S ip-address:8080

..\path\php.exe -S ip-address:8080

You can now put the ip-address:8080 into the url bar of your browser and you will be able to see the website.