Skip to content

Zamiell/isaac-racing-client

Repository files navigation

isaac-racing-client


Download & Additional Information

Please visit the website for Racing+.


Description

This is the client software for Racing+, a Binding of Isaac: Repentance racing platform. Normally a single player game, the Lua mod, client, and server allow players to be able to race each other in real time.

The client is written with Electron and uses WebSockets to communicate with the server. The pretty elements are courtesy of HTML5 UP.

You may also be interested in the Lua mod or the Go server.


Settings

The location for the client settings file is: C:\Users\[Username]\AppData\Local\Programs\settings.json


Run from Source (on Windows)

  • Install node.js.
  • Install Git.
  • git clone https://github.com/Zamiell/isaac-racing-client.git
  • cd isaac-racing-client
  • npm ci
  • ./run.sh

Run from Source (on Ubuntu 18.04)

  • Install curl and Git:
    • sudo apt install curl git -y
  • Install node.js (using nvm to do this is recommended):
    • curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash
    • Close and reopen Terminal.
    • nvm install node
  • git clone https://github.com/Zamiell/isaac-racing-client.git
  • cd isaac-racing-client
  • npm ci
  • ./run.sh

Build (on Windows)

  • Install Python 3.9.
  • python.exe release.py

Dependency Notes

  • We cannot update to the latest version of electron due to a bug with it not sending the previously gotten cookie when establishing a websocket connection.
  • We cannot update to the latest version of node-fetch and @types/node-fetch due to TypeScript not supporting ESM-only modules.