Add HTTP Server Support

Open
#32 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
csharp
Domain
api, backend

Research direction

Start by tracing the existing socket server entry point in the LiveSplit.Server component; the issue does not name a file or test. Add an HTTP endpoint that forwards the requested command to the socket server and supports browser CORS, then verify that browser-based requests can trigger commands without requiring a separate proxy.

Written by the indexing model from the issue text.

Description

TL; DR: Please consider adding a HTTP server (that is CORS aware) in addition to the socket server.

I was trying to use LiveSplit with a web browser based game via a Web Extension. Extensions can't open socket connections. Chrome apps can, but a browser app didn't seem appropriate for my project. So I ended up writing a thin Go wrapper to proxy HTTP to Socket, that ignores CORS, and ignores socket responses.

package main

import (
	"fmt"
	"log"
	"net"
	"net/http"
)

func handler(w http.ResponseWriter, r *http.Request) {
	conn, _ := net.Dial("tcp", "127.0.0.1:16834")
	fmt.Fprintf(conn, "%s\r\n", r.URL.Path[1:])
	fmt.Fprintf(w, "")
}

func main() {
	http.HandleFunc("/", handler)
	log.Fatal(http.ListenAndServe(":16835", nil))
}

From my extension, I'd call it like this:

sendCmd = (cmd) ->
    request = new XMLHttpRequest
    request.open "POST", "http://127.0.0.1.nip.io:16835/#{cmd}", true
    do request.send

sendCmd 'startorsplit'

Whatever was sent as the PATH of the URL is used as the socket command. Using form data, etc, would be fine, too. This solution worked quite well for my use case. I had to grant permission to the domain in my extension, but if the proxy served a CORS header like Access-Control-Allow-Origin: * it should just work without a domain permission. If a simple HTTP server was setup as part of this live split extension, then it would be really easy to build LiveSplit integrations for any browser based web game.

Dominant language
C#
Stars
52
Forks
33
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from LiveSplit/LiveSplit.Server

All issues in LiveSplit/LiveSplit.Server

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.