https://github.com/zamiell/racing-plus

The mod for Racing+, a Binding of Isaac racing platform.
https://github.com/zamiell/racing-plus

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/zamiell/racing-plus
• Owner: Zamiell
• License: gpl-3.0
• Created: 2021-05-17T02:19:36.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-17T23:31:49.000Z (5 months ago)
• Last Synced: 2024-09-18T03:52:00.122Z (5 months ago)
• Language: TypeScript
• Homepage:
• Size: 80.1 MB
• Stars: 10
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# The Racing+ Mod

## Download & Additional Information

Please visit [the website for Racing+](https://isaacracing.net/) or [subscribe to the mod on the Steam Workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=857628390).




## Description

This is the mod for Racing+, a _[Binding of Isaac: Repentance](https://store.steampowered.com/app/1426300/The_Binding_of_Isaac_Repentance/)_ racing platform. Normally a single player game, the mod, client, and server allow players to be able to race each other in real time.

This mod is written using [IsaacScript](https://isaacscript.github.io/).

See also:

- [Mod changes](docs/changes.md)

- [Race formats](docs/race-formats.md)

- [Custom challenges](docs/challenges.md) (i.e. multi-character speedruns)

- [Version history on GitHub](https://github.com/Zamiell/isaac-racing-client/blob/master/HISTORY.md)

- [Version history on the Steam Workshop](https://steamcommunity.com/sharedfiles/filedetails/changelog/857628390)

- [Known bugs](docs/bugs.md)

You may also be interested in [the client repository](https://github.com/Zamiell/isaac-racing-client) or [the server repository](https://github.com/Zamiell/isaac-racing-server).




## Installation for Development

Racing+ is open source and anyone can help contribute to make the mod better. If you are interested in helping, this section will help you get started. If you get stuck, post a message in the `#development` channel on the [Isaac Racing Discord server](https://discord.gg/JzbhWQb).

- Before working with this repository, you should first become a familiar with IsaacScript. Follow the steps on [the IsaacScript getting started documentation](https://isaacscript.github.io/docs/getting-started). Once you have created a test mod and verified in-game that everything works the way it should, read on.

- Download and install [Git](https://git-scm.com/), if you do not have it already.

- Open a new [command prompt window](https://www.howtogeek.com/235101/10-ways-to-open-the-command-prompt-in-windows-10/). (Or, feel free to use Windows Terminal, PowerShell, Git Bash, etc.)

- Configure Git, if you have not done so already:

  - `git config --global user.name "Your_Username"`

  - `git config --global user.email "[email protected]"`

- Fork the repository by clicking on the button in the top-right-hand-corner of the repository page.

- Clone your forked repository:

  - `cd [the path where you want the code to live]` (optional)

  - If you already have an SSH key pair and have the public key attached to your GitHub profile, then use the following command to clone the repository via SSH:

    - `git clone [email protected]:[username]/racing-plus.git`

    - (Replace "[username]" with your GitHub username.)

  - If you do not already have an SSH key pair, then use the following command to clone the repository via HTTPS:

    - `git clone https://github.com/[username]/racing-plus.git`

    - (Replace "[username]" with your GitHub username.)

- Enter the cloned repository:

  - `cd racing-plus`

- Install Yarn, if you have not done so already:

  - `corepack enable`

- Install dependencies:

  - `yarn install`

- Run IsaacScript, which will compile the mod and copy it to your "mods" folder:

  - `npx isaacscript`