search

diegoquintanav / go-joystick

a d-pad controller in go to send commands using websockets
1 stars 0 forks source link

readme

About

A joystick service that sends commands to a websocket, written in go.

joystick-preview

Usage

$ go run cmd/joystick-server/server.go
connecting to localhost:8080

in another terminal

$ go run cmd/joystick-client/client.go
connecting to localhost:8081

Go to the client in the browser and move the joystick around. The server will receive the commands and print them to the console.

Check the available flags for the server and client:

go run cmd/joystick-client/client.go -help
Usage of /tmp/go-build2401914539/b001/exe/client:
  -clientAddr string
        http client address. Must include the port. Does not include the protocol (http://) (default "localhost:8081")
  -clientName string
        Name of the user client. Used to identify the client to the server
  -serverAddr string
        websocket or http service address. Must include the protocol (ws:// or http://) and the port number (default "ws://localhost:8080")
  -serverEndpoint string
        Endpoint at the server to connect to where messages will be sent (default "/echo")

and for the toy server:

$ go run cmd/joystick-server/server.go -help
Usage of /tmp/go-build1929449632/b001/exe/server:
  -serverAddr string
        HTTP service address where the server will be listening from. Does not include the protocol (http://) (default "localhost:8080")

For example, to connect to the echo server in the server.go file, run the following command:

$ go run cmd/joystick-client/client.go  -serverAddr ws://localhost:8080 -serverEndpoint /echo -clientAddr localhost:8081 -clientName "test-client"

Developing with air

Air allows, among other things, to live reload applications during development. In separate terminals run the following commands:

$ air -c .air.joystick-client.toml # runs the client in port 8091
$ air -c .air.joystick-server.toml # runs the server in port 8090

To connect to the sompics server, run the following command:

$ air -c .air.joystick-client-sompics.toml # runs the server in port 8091, and connects to sompics in port 9080

Connect to Sompics server using docker compose

Use make for convenience. Run the following command:

$ make docker-compose.client.sompics.up

By default this container maps the port 8081 to the port 8090 in the host machine. Read the Makefile for more details.

License

MIT

Credits