Allows the user to broadcast keyboard inputs from a client to server in order to play games over multiple PCs (and more)
There is a requirements.txt included in the package, meaning that dependency installation can be done in one command. Run this in the root folder of the package:
pip install -r requirements.txtThat's it! All the requirements are automatically installed by pip
Set up ngrok if you want to play over the internet when the Server and Client are connected to different networks. This is mandatory if you want to use ngrok
Go to the ngrok website and sign up for an account
After creating an ngrok account, go to the auth dashboard and copy your Tunnel Authtoken.
Open ngroksetup.py and paste this in the provided text field. Click the Set Auth Token button in order to finalise the auth token and store it. If this is successful, a text field will appear showing you the auth token you entered in order to confirm that the auth token has been set successfully
Use server.py to achieve this. The features are listed below:
The hostname is automatically detected by the code and is shown in the top of the window. If you wish to use this as your host, leave the hostname field blank. The automatically detected hostname will be used as the host and displayed in the hostname for client field so it can be copied and sent to the client PC. Note that you have to be on the same wi-fi network in order for this to work. If you are not connected to the same router, then use ngrok (detailed later)
If you fill in a hostname, then this will be used unless you choose to use ngrok. This can be used in case the automatic host detection works incorrectly(unlikely) or if the laptops are connected by an ethernet cable to lower input lag (recommended if you understand how IP addresses work)
Only use ngrok if it is impossible to connect to the same router as the other computer, since it introduces lag because it sends the key presses via an external server (it's secure, don't worry)
When choosing the ngrok region, ensure that you choose the region (geographically)closest to you in order to minimize ping and therefore input lag
Enter the characters into the characters text field without any separation. Arrow keys and Space are not supported. e.g. - 'wasd' or 'esdf' (without the quotes)
In order to start the server, simply click start server after entering all the required fields
Using auto-detected hostname: characters
Using ngrok: ngrok checkbox, ngrok region, characters
Using own hostname: hostname, characters
Once the server has been started, click the Copy button in order to copy the hostname to give to the Client PC. This can then be sent to the Client PC in order to connect to the server
Once a client has connected and disconnected, the server must be stopped and restarted before it can connect to a client again
In the host text field, enter the hostname that the Server PC copied and sent. This will tell the Client which PC to connect to.
To connect to the server, press the Connect button (as if that wasn't obvious). The server must be online or the application will freeze
Once the Client has connected to the Server, a character string will appear in its text box. These are the characters that the client is allowed to broadcast to the server. There is a rebind feature which will allow the user to rebind these keys to different keys on the physical keyboard. Enter the rebind string and click Update rebinds in order to register the new rebind string
For example, if the character string is wasd and the rebind string is entered as esdf, then when e is pressed on the client's keyboard, it will register as w. When s is pressed, it will register a. In other words, each key is rebound to its respective key in the rebind string.
The rebind string has to be the same length as the character string in order to bind each key to its respective rebind. If they are not the same length, then rebinds are disabled until a new, valid rebind string is entered