https://github.com/zamiell/isaac-racing-client

The client software for Racing+, a Binding of Isaac racing platform.
https://github.com/zamiell/isaac-racing-client

electron

Last synced: 3 months ago
JSON representation

The client software for Racing+, a Binding of Isaac racing platform.

• Host: GitHub
• URL: https://github.com/zamiell/isaac-racing-client
• Owner: Zamiell
• License: gpl-3.0
• Created: 2016-10-01T18:10:28.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-02-23T07:31:46.000Z (11 months ago)
• Last Synced: 2024-02-24T07:27:11.229Z (11 months ago)
• Topics: electron
• Language: TypeScript
• Homepage: https://isaacracing.net/
• Size: 55.6 MB
• Stars: 27
• Watchers: 4
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# isaac-racing-client




## Download & Additional Information

Please visit [the website for Racing+](https://isaacracing.net/).




## 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](http://electron.atom.io/) and uses WebSockets to communicate with the server. The pretty elements are courtesy of [HTML5 UP](https://html5up.net/).

You may also be interested in [the Lua mod](https://github.com/Zamiell/racing-plus) or [the Go server](https://github.com/Zamiell/isaac-racing-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](https://nodejs.org/en/download/).

- Install [Git](https://git-scm.com/download/win).

- `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](https://curl.haxx.se/) and [Git](https://git-scm.com/):

  - `sudo apt install curl git -y`

- Install [node.js](https://nodejs.org/en/) (using [nvm](https://github.com/creationix/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.