Jump to Known Bugs
Download the client zip file from the repository (the button above takes you there). You can do so on the device you'll be installing the client on (i.e. a Raspberry Pi device) or you can download it to your regular PC and then transfer the file via a remote connection software (like VNC viewer).
Transfer the zip file you just downloaded to your client device and put it somewhere easy to remember (I recommend the desktop).
Extract the contents of the zip file to a place easy to remember (again I recommend the desktop). You should now have a new folder in that location that has all the dependencies and the install script.
Open your CMD or command line program and change your directory to the extracted folder from the previous step. Once there run the following command
Wait for setup to complete and answer any prompts that pop up. One will ask if you want StreamPi to boot at start up, this will make it so when you turn on the Raspberry Pi it will immediately start as a Stream Pi. There is presently no way to turn this off in the software itself.
The CMD window won't close when it finishes. When it does finish, it will give you a command to run to launch the client. It should look something like this:
If you enabled run at boot, you don't need this command.
You're almost done! Use that command to run the client, and then go into settings (hitting the button or swiping up) and change the default Server IP to the IP you see in the StreamPi Server (if you don't know that yet b/c you haven't done server set up, you can leave it for now and then change the IP when you finish server set up.
Download and install the OBS Socket Plugin If OBS is running when you install this, restart it and if a network prompt comes up, click allow.
Download the server zip file from the repository (the button above takes you there). Put the zip file somewhere easy to remember (I recommend the desktop or a folder on the desktop)
Extract the contents of the zip file to a place easy to remember (again I recommend the desktop). You should now have a new folder in that location that has all the dependencies and a batch file.
Install the Roboto-Regular.ttf (present in the folder / zip).
Run the server.bat file (for Windows) and take note of the IP it gives you
You're almost done! If you haven't yet completed Client set up, go ahead and do that now. Then go into client settings and change the default IP to the one listed on the running server.
Check the CMD window for any errors
|StreamPiServer.Main can not be found when the Main.class DOES exist||Windows (May occur on others)||Add "-cp ./StreamPiServer;" After "jdk/bin/java" in the server start file|