isaac-achievement-randomizer

READ THE MANUAL HERE

Achievement Randomizer is a mod for The Binding of Isaac: Repentance that gives you the experience of playing through the game from scratch, unlocking each item one by one in a randomized way.

• Check out the documentation.
• Also see the version history.

Discord

For questions about playing the mod, or reporting bugs, contact us in the Isaac Streaking Discord server. (Discord is a voice and text chat application that allows anyone to create a hosted server. We use one such server as the primary hub of communication for Isaac streaking.)

Website

You can use a dedicated website to view the status of your randomizer save file. Currently, the website does not work properly and is under development.

How To Play

For normal people, you can play the mod by subscribing to it on the Steam Workshop. (Subscribing to the mod will automatically download and install it once you launch the game.)

Installation for Development

Achievement Randomizer 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 #randomizer-development channel on the Isaac Streaking Discord server.

• Before working with this repository, you should first become a familiar with IsaacScript. Follow the steps on the IsaacScript getting started documentation. Once you have created a test mod and verified in-game that everything works the way it should, read on.
• Download and install Git, if you do not have it already.
• Open a new command prompt window. (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 "your@email.com"
• 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 git@github.com:[username]/isaac-achievement-randomizer.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]/isaac-achievement-randomizer.git
    • (Replace "[username]" with your GitHub username.)
• Enter the cloned repository:
  • cd isaac-achievement-randomizer
• 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

Credits

The mod was designed by Zamiel and Gamonymous, with some help from Moucheron Quipet.

It is written in TypeScript using the IsaacScript framework.