Skip to content

Commit c0f7891

Browse files
authored
Update README.md
1 parent bac99e9 commit c0f7891

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

README.md

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,46 @@
11
## SocketJoy
22

3-
**Note** : This project is currently only being tested on linux (and may not work on windows). Once the frontend implementation is done, I'll start testing on windows.
4-
53
Use your mobile phone as a virtual xbox controller for your windows or linux pc!
64

75
This project relies on work done by @qbolec with [joydiv](https://github.com/qbolec/Joydiv) and the [j2dx](https://github.com/OzymandiasTheGreat/Joy2DroidX-server/) server written by @OzymandiasTheGreat, so huge thanks to them!
86

9-
### Install Script:
7+
### Quickstart
8+
9+
#### Windows
10+
11+
__Server:__
12+
```
13+
wget https://github.com/OzymandiasTheGreat/Joy2DroidX-server/releases/download/v0.1.0/Joy2DroidX-server-0.1.0-x86_64.exe
14+
```
15+
16+
Or simply download and run this server [executable](https://github.com/OzymandiasTheGreat/Joy2DroidX-server/releases/download/v0.1.0/Joy2DroidX-server-0.1.0-x86_64.exe)
17+
18+
Note that you can run the exe in a cmd terminal and pass in `-d` to enable debugging on the server side.
19+
```
20+
Joy2DroidX-server-0.1.0-x86_64.exe -d
21+
```
22+
23+
__Client:__
24+
25+
```
26+
git clone https://github.com/harsh2204/socketjoy.git
27+
cd socketjoy
28+
python3 -m http.server
29+
```
30+
31+
Connect to the client address with the correct port to complete the quickstart.
32+
33+
---
34+
35+
#### Linux:
36+
1037
The following script is a quick way to get the server and client up and running with one command. The server and client will be installed in a directory called `virtual-controller`.
1138
```
1239
bash <(curl -s https://gist.githubusercontent.com/harsh2204/ad0edf5ef6298464fb5f6d50bd01196f/raw)
1340
```
1441

1542
To run the server again you can simply go into `virtual-controller/socket-joy` and run `./run.sh`.
43+
1644
### Manual Setup and Deployment Steps:
1745

1846
* install j2dx plugin and set it up. See instuctions [from my fork](https://github.com/harsh2204/Joy2DroidX-server) or [here](https://github.com/OzymandiasTheGreat/Joy2DroidX-server/#installation)

0 commit comments

Comments
 (0)