Allow passing path to Steam files to Crankshaft, and expose it to plu…

…gins

build/build.go

@@ -89,31 +89,33 @@ func BundleSharedScripts() (string, error) {
 var evalScriptTemplate string
 
 // BuildEvalScriptFromFile gets a script from a file and builds an eval script with it.
-func BuildEvalScriptFromFile(serverPort string, uiMode cdp.UIMode, scriptPath string) (string, error) {
+func BuildEvalScriptFromFile(serverPort string, uiMode cdp.UIMode, scriptPath string, steamPath string) (string, error) {
 	scriptBytes, err := ioutil.ReadFile(scriptPath)
 	if err != nil {
 		return "", fmt.Errorf(`Failed to read injected script at "%s": %w`, scriptPath, err)
 	}
 
 	script := string(scriptBytes)
 
-	return BuildEvalScript(serverPort, uiMode, script)
+	return BuildEvalScript(serverPort, uiMode, script, steamPath)
 }
 
 // BuildEvalScript builds a script to be evaluated in the Steam target context.
-func BuildEvalScript(serverPort string, uiMode cdp.UIMode, script string) (string, error) {
+func BuildEvalScript(serverPort string, uiMode cdp.UIMode, script string, steamPath string) (string, error) {
 	evalTmpl := template.Must(template.New("eval").Parse(evalScriptTemplate))
 	var evalScript bytes.Buffer
 	if err := evalTmpl.Execute(&evalScript, struct {
 		Version        string
 		InjectedScript string
 		ServerPort     string
 		UIMode         cdp.UIMode
+		SteamDir       string
 	}{
 		Version:        VERSION,
 		InjectedScript: script,
 		ServerPort:     serverPort,
 		UIMode:         uiMode,
+		SteamDir:       steamPath,
 	}); err != nil {
 		return "", fmt.Errorf("Failed to execute eval script template: %w", err)
 	}

build/eval.template.js

@@ -3,5 +3,6 @@ document.querySelectorAll('[data-smm-id]').forEach((node) => node.remove());
 
 window.smmServerPort = '{{ .ServerPort }}';
 window.smmUIMode = '{{ .UIMode }}';
+window.csSteamDir  = '{{ .SteamDir }}';
 
 {{ .InjectedScript }}

cmd/crankshaft/main.go

@@ -30,7 +30,7 @@ func main() {
 }
 
 func run() error {
-	debugPort, serverPort, skipPatching, dataDir, pluginsDir, logsDir := config.ParseFlags()
+	debugPort, serverPort, skipPatching, dataDir, pluginsDir, logsDir, steamPath := config.ParseFlags()
 
 	// Ensure data directory exists
 	if err := os.MkdirAll(dataDir, 0700); err != nil {
@@ -72,7 +72,7 @@ func run() error {
 	waitAndPatch := func() {
 		cdp.WaitForConnection(debugPort)
 		cdp.WaitForLibraryEl(debugPort)
-		patcher.Patch(debugPort, serverPort)
+		patcher.Patch(debugPort, serverPort, steamPath)
 	}
 
 	if len(os.Getenv("DISPLAY")) != 0 {
@@ -119,7 +119,7 @@ func run() error {
 			ws.ServeWs(hub, w, r)
 		})
 
-		rpcServer := rpc.HandleRpc(debugPort, serverPort, plugins, devmode.DevMode, hub)
+		rpcServer := rpc.HandleRpc(debugPort, serverPort, plugins, devmode.DevMode, hub, steamPath)
 
 		http.Handle("/rpc", handlers.CORS(
 			handlers.AllowedHeaders([]string{"Content-Type"}),

config/flags.go

@@ -15,7 +15,7 @@ func GetXdgStateHome() string {
 	return xdg.StateHome
 }
 
-func ParseFlags() (debugPort string, serverPort string, skipPatching bool, dataDir string, pluginsDir string, logsDir string) {
+func ParseFlags() (debugPort string, serverPort string, skipPatching bool, dataDir string, pluginsDir string, logsDir string, steamPath string) {
 	dataHome := GetXdgDataHome()
 	stateHome := GetXdgStateHome()
 
@@ -25,6 +25,7 @@ func ParseFlags() (debugPort string, serverPort string, skipPatching bool, dataD
 	dataDir = *flag.String("data-dir", path.Join(dataHome, "crankshaft"), "Crankshaft data directory")
 	pluginsDir = *flag.String("plugins-dir", path.Join(dataHome, "crankshaft", "plugins"), "Directory to load plugins from")
 	logsDir = *flag.String("logs-dir", path.Join(stateHome, "crankshaft", "logs"), "Directory to write logs to")
+	steamPath = *flag.String("steam-path", path.Join(dataHome, "Steam"), "Path to Steam files")
 	flag.Parse()
 	return
 }

patcher/patcher.go

@@ -3,16 +3,9 @@ package patcher
 
 import (
 	"path"
-
-	"git.sr.ht/~avery/crankshaft/pathutil"
-	"github.com/adrg/xdg"
 )
 
-func getSteamUiPath() string {
-	return pathutil.SubstituteHomeDir(path.Join(xdg.DataHome, "Steam", "steamui"))
-}
-
 // Patch patches necessary Steam resources.
-func Patch(debugPort string, serverPort string) {
-	PatchJS(getSteamUiPath(), debugPort, serverPort)
+func Patch(debugPort string, serverPort string, steamPath string) {
+	PatchJS(path.Join(steamPath, "steamui"), debugPort, serverPort)
 }

rpc/inject/inject.go

@@ -16,10 +16,11 @@ type InjectService struct {
 	serverPort string
 	plugins    *plugins.Plugins
 	devMode    bool
+	steamPath  string
 }
 
-func NewInjectService(debugPort, serverPort string, plugins *plugins.Plugins, devMode bool) *InjectService {
-	return &InjectService{debugPort, serverPort, plugins, devMode}
+func NewInjectService(debugPort, serverPort string, plugins *plugins.Plugins, devMode bool, steamPath string) *InjectService {
+	return &InjectService{debugPort, serverPort, plugins, devMode, steamPath}
 }
 
 type InjectArgs struct{}
@@ -82,9 +83,9 @@ func (service *InjectService) Inject(r *http.Request, req *InjectArgs, res *Inje
 
 	var libraryEvalScript string
 	if service.devMode {
-		libraryEvalScript, err = build.BuildEvalScriptFromFile(service.serverPort, steamClient.UiMode, ".build/library.js")
+		libraryEvalScript, err = build.BuildEvalScriptFromFile(service.serverPort, steamClient.UiMode, ".build/library.js", service.steamPath)
 	} else {
-		libraryEvalScript, err = build.BuildEvalScript(service.serverPort, steamClient.UiMode, libraryScript)
+		libraryEvalScript, err = build.BuildEvalScript(service.serverPort, steamClient.UiMode, libraryScript, service.steamPath)
 	}
 	if err != nil {
 		log.Println(err)
@@ -101,9 +102,9 @@ func (service *InjectService) Inject(r *http.Request, req *InjectArgs, res *Inje
 	if steamClient.UiMode == cdp.UIModeDeck {
 		var menuEvalScript string
 		if service.devMode {
-			menuEvalScript, err = build.BuildEvalScriptFromFile(service.serverPort, steamClient.UiMode, ".build/menu.js")
+			menuEvalScript, err = build.BuildEvalScriptFromFile(service.serverPort, steamClient.UiMode, ".build/menu.js", service.steamPath)
 		} else {
-			menuEvalScript, err = build.BuildEvalScript(service.serverPort, steamClient.UiMode, menuScript)
+			menuEvalScript, err = build.BuildEvalScript(service.serverPort, steamClient.UiMode, menuScript, service.steamPath)
 		}
 		if err != nil {
 			log.Println(err)

rpc/rpc.go

@@ -9,12 +9,12 @@ import (
 	rpcJson "github.com/gorilla/rpc/v2/json"
 )
 
-func HandleRpc(debugPort, serverPort string, plugins *plugins.Plugins, devMode bool, hub *ws.Hub) *rpc.Server {
+func HandleRpc(debugPort, serverPort string, plugins *plugins.Plugins, devMode bool, hub *ws.Hub, steamPath string) *rpc.Server {
 	server := rpc.NewServer()
 	server.RegisterCodec(rpcJson.NewCodec(), "application/json")
 	server.RegisterService(network.NewNetworkService(), "NetworkService")
 	server.RegisterService(new(FSService), "")
-	server.RegisterService(inject.NewInjectService(debugPort, serverPort, plugins, devMode), "InjectService")
+	server.RegisterService(inject.NewInjectService(debugPort, serverPort, plugins, devMode, steamPath), "InjectService")
 	server.RegisterService(NewPluginsService(plugins), "PluginsService")
 	server.RegisterService(NewIPCService(hub), "IPCService")
 	return server