/isaacscript

Primary LanguageTypeScriptGNU General Public License v3.0GPL-3.0

IsaacScript

Discord

IsaacScript is a tool to help you create Binding of Isaac: Repentance mods using TypeScript.

Please visit the official website for more information.

This is the monorepo that houses the various packages in the ecosystem. It is powered by Nx.


Packages

Each project in the monorepo is contained within the "packages" directory.

Name Description Version
docs The Docusaurus website. n/a
eslint-config-isaacscript A sharable ESLint config for TypeScript and IsaacScript projects. npm version
eslint-plugin-isaacscript An ESLint plugin that contains useful rules. npm version
isaacscript-cli The command-line tool for managing Isaac mods written in TypeScript. npm version
isaacscript-common Helper functions and features for IsaacScript mods. npm version
isaacscript-lint A linting dependency meta-package for IsaacScript and TypeScript projects. npm version
isaacscript-spell Spelling dictionaries for The Binding of Isaac: Repentance. npm version
isaacscript-tsconfig A sharable TypeScript config for TypeScript and IsaacScript projects. npm version
isaac-typescript-definitions TypeScript definitions for the The Binding of Isaac: Repentance API. npm version

Getting Started with Development

For getting started in building your own mods, see the website. For contributing to the IsaacScript project itself, read on.

  • Download and install Node.js, if you don't have it already.
  • Download and install Git, if you don't have it already.
  • Download and install VSCode, if you don't have it already.
  • Open a new command prompt window or shell of your choice.
  • Configure Git, if you have not done so already:
    • git config --global user.name "Your_Username"
    • git config --global user.email "your@email.com"
  • Clone the repository:
    • cd [the path where you want the code to live]
    • 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 git@github.com:IsaacScript/isaacscript.git
    • 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/IsaacScript/isaacscript.git
    • Or, if you are doing development work, then clone your forked version of the repository. For example:
      • git clone https://github.com/Your_Username/isaacscript.git
  • Enter the cloned repository:
    • cd isaacscript
  • Ensure that Yarn (v1) is installed:
    • corepack enable
  • Install dependencies:
    • yarn
  • Open the monorepo in VSCode:
    • code .