Uploading A Mod
Uploading a mod isn't terribly difficult; but, there is a few steps you need to do before uploading.
- Create a Thumbnail Image
- Create a Workshop Image
- 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.
- Use the thumbnail image to highlight or show off the main part of your mod. A character mod for example may make a blown up version of their character portrait for the thumbnail.
- Avoid using high contrasting backgrounds. If the picture doesn't have a focal point, peoples eyes won't know what to look at and will just end up not looking at all. A bad example of this is assume someone made a druid type character, for their thumbnail they put them in a dense tropical forest. Well the druid is already heavily green, and so is tropical the forest. This means the character will more or less blend in and our eyes may not even notice the character let alone focus on it. Instead what that person should do is focus on something like the druid sitting on a stump, that way you can still be in the forest, but the background is a different color from the main character.
- Use the Workshop iamge to show off what your mod is all about. Examples of this is cool synergies, one of the cool new bosses, or the unique mechanic of an item or character. you can add multiple of these types of images, so don't be afraid to take multiple.
- You can also make gifs (animated pictures) thumbnail/workshop images!
- Youtube videos work in the workshop images section too!
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.
- 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.
- 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.
- Open Steam
- Right click "The Binding of Isaac: Rebirth"
- Go Down to "Manage"
- Click "Browse local files"
- 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.
- Change Notes. This is where you should put what you have changed when you update you mod. for initial upload, it is recommened to put Initial Upload or something similar.
- Mod Description. This is where you put the Description for your mod that will appear on the workshop page. It is recommened to do this in another editor first and paste it in. Steam has its own formatting codes you can use to do certain things like: bold, italic, headers. See Here
- Tags. This is the mod categories that you can classify your mod under. Be sure to click all that apply!
- Visibility. By default its Public, this changes who can see your mod page. You can set it to Private if you want to make more changes before letting people actually see your mod if you want.
- Thumbnail Image. This is for uploading your thumbnail image, hit the Change button, and find your thumbnail image. You don't need to apply this every time you update, just if you want to change it again
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
- Open Steam
- Click on Isaac
- Click "Workshop"
- Under the "Browse" dropdown on the workshop page, Hit "Subscribed Items"
- at the top of that page you can find a radio control for "By YOURNAME" or "YOUR favorite's". Change it to "BY YOURNAME".
- The mod(s) you have made will now show up
- Click the mod you just uploaded
- 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!
- Edit title & description. This lets you edit the name and description of your mod. DO NOT change it like this, use the Mod Uploader tool! The reason is when you go to update your mod the Mod Uploader tool will overwrite anything you change back to the Original text that you inputted using the tool the first time.
- Add/edit images & videos. This let's you attach Workshop Images (like the big one(s) you made), along with youtube videos, and even sketchfab (if for some reason you have one).
- Add/remove Contributors. This menu let's you add or remove contributors from your mod page. NOTE: They have to be on your friends list!
- Edit Links. This button isn't about your mod; instead, it lets you link to your other platforms like Youtube and Twitter. They show on the right side of the mod page when added.
- Allow Comments. Simple checkbox of whether the Comment Section is Enabled for your mod page. Unchecking this will both hide all comments already made, and disallow new comments from being made!
- Delete. Scary button! This button will delete your mod off the steam workshop forever That's a very long time.
- Add/Remove Required DLC. This lets you add DLC from the game as required to make your mod work. It is common courtesy to add at least Afterbirth+ as a required DLC; since that DLC is needed to mod Isaac, but be sure to add Repentance too if this mod is made for Repentance!
- Add/Remove Required Items. This lets you add other mods on the workshop as a requirement for your mod to work. Note: You must either be subscribed to it, have it favorited, or be the publisher of it, to add the item.
- Change Visibility. This lets you change between the different kinds of visibilities your mod page has, be sure to set to this public if you initially set it to private when uploading your mod. Also double check when you reopen the mod uploader that it is switched to public again, or else the next time you update it, your mod will go "poof" again.
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!