https://github.com/zamiell/isaac-console-commands

https://github.com/zamiell/isaac-console-commands

Last synced: 4 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/zamiell/isaac-console-commands
• Owner: Zamiell
• License: gpl-3.0
• Created: 2024-01-02T02:18:01.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-02T02:18:49.000Z (about 1 year ago)
• Last Synced: 2025-01-27T17:17:12.948Z (11 days ago)
• Language: TypeScript
• Size: 121 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# isaac-console-commands

isaac-console-commands is a mod for [_The Binding of Isaac: Repentance_](https://store.steampowered.com/app/1426300/The_Binding_of_Isaac_Repentance/), written in [TypeScript](https://www.typescriptlang.org/) using the [IsaacScript](https://isaacscript.github.io/) framework.

## How To Play

For normal people, you can play the mod by subscribing to it on [the Steam Workshop](https://steamcommunity.com/app/250900/workshop/). (Subscribing to the mod will automatically download and install it once you launch the game.)

## How To Compile

If you are a developer, or if the mod is not yet uploaded to the Steam Workshop, you can play the mod by compiling the TypeScript code into a "main.lua" file. Perform the following steps:

- Download and install [Node.js](https://nodejs.org/en/download/) (Windows Installer .msi, 64-bit).

- Download and install [Git](https://git-scm.com/download/win) (64-bit Git for Windows setup).

- Download (or clone) this repository:

  - Click on the "Code" button in the top-right-corner of this page.

  - Click on "Download ZIP".

- Unzip the zip file to a new directory.

- Open the command prompt (or another shell of your choice).

- Use the `cd` command to navigate to the place where you unzipped the repository.

- Use the `yarn install --immutable` command to install the project dependencies.

- Use the `npx isaacscript` command to start the IsaacScript watcher.

- If IsaacScript is successful, you will see "Compilation successful." (You can continue to leave the terminal window open; it will monitor for changes in your project, and recompile if necessary.)

- Completely close Isaac if it is already open, and then open the game again, and the mod should be in the list of mods. You can now play or test the mod.