Uploading A Mod

Uploading a mod isn't terribly difficult; but, there is a few steps you need to do before uploading.

  1. Create a Thumbnail Image
  2. Create a Workshop Image
  3. Do Manual Edits to metadata.xml

Important: Images created for the workshop DO NOT need to be put into the Mod folder

The images used by the workshop are in no way used by the mod. So we have no reason to put them into the mods folder. You still can if you want to though.
The Thumbnail Image (which is what you see when scrolling past) is a 268x268 image; however, you can just make a 512x512 and let the workshop crop it.
The Workshop image is what you get when click into the actual mod page. It is a 16:9 Ratio Image, I would suggest at least 1920 x 1080.
If you have never made images like this before, here are some general suggestions.

Once you have at least the thumbnail image complete, we can move onto the next step!
We may need to do a few things manually in the metadata.xml file. This is dependant on you though, so you may not need to do this at all!
So open up your mod's folder, and open the metadata.xml file.
inside there is two lines that you may need to change here.

  1. The "Directory" line should be named the same way your folder is. It should already be like that unless you renamed your folder through making your mod.
  2. The "Name" line should be named whatever you want your mod to be called. It will automatically default to the folder name.

Once done it's time to open the Mod uploader tool and do actually upload the mod.
To navigate to the mod uploader tool you can find it in your Isaac install/tools/ModUploader/
If you don't know how to get to your Isaac install do this.

  1. Open Steam
  2. Right click "The Binding of Isaac: Rebirth"
  3. Go Down to "Manage"
  4. Click "Browse local files"
  5. It will open your file explorer straight to your Isaac Install

Inside the uploader tool hit the "Choose Mod..." button and then open the metadata.xml file of your mod.
There is multiple things you can change in here.

When you're done changing things. Hit "Upload Mod".
Down below in the small box, it will tell you when its finished.
When it is finished, close the Mod Uploader. Don't bother with the "View Mod" button, it opens in your browser which isn't very useful.
Instead we want to go to your mod page through steam

  1. Open Steam
  2. Click on Isaac
  3. Click "Workshop"
  4. Under the "Browse" dropdown on the workshop page, Hit "Subscribed Items"
  5. at the top of that page you can find a radio control for "By YOURNAME" or "YOUR favorite's". Change it to "BY YOURNAME".
  6. The mod(s) you have made will now show up
  7. Click the mod you just uploaded
  8. Now you can change things from here

Workshop

On the right side of the Workshop page is a menu called "Owner Controls".
Each control lets you do something different. Let's go over them all!

Congratulations. You have uploaded your first mod! Be sure to post about it in the Isaac Discord (#modding-general) or In the Isaac Modding Discord (#promotion) if you are a part of those!