Difference between revisions of "Modding Tutorials/Distribution"

From RimWorld Wiki
Jump to navigation Jump to search
(Made more in line with other tutorials)
(→‎Steam: => common issues)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
{{BackToTutorials}}
+
{{BackToTutorials}}<br/>
−
{{Credit|[[User:Alistaire|Alistaire]]}}<br/>
 
  
 
This tutorial suggests steps to take when releasing your mod.<br/><br/>
 
This tutorial suggests steps to take when releasing your mod.<br/><br/>
Line 8: Line 7:
 
* (Optional): This tutorial requires you to have [[Modding Tutorials/Setting up a solution|set up a solution]].
 
* (Optional): This tutorial requires you to have [[Modding Tutorials/Setting up a solution|set up a solution]].
 
* (Optional): You will have to [[Modding Tutorials/Writing custom code|have written code]] (there's no use in an empty project).<br/><br/>
 
* (Optional): You will have to [[Modding Tutorials/Writing custom code|have written code]] (there's no use in an empty project).<br/><br/>
 +
 +
=Preparation=
 +
# Compile all your DLLs and make sure they're in the Assemblies folder.
 +
# Activate your mod. Test it. Your mod should not cause any errors, warnings or other logspam on startup.
 +
# '''Recommended''': Consider a license, preferably one that will let other modders update and expand upon your mod.
 +
# '''Optional''': Make a copy of your mod folder for release. This folder shouldn't contain files that aren't of interest to most users.
 +
## Backups of older versions of textures and such can be removed from this folder.
 +
## Your .git folder and the .vs and bin/obj folders made by your IDE/Visual Studio can be removed.
 +
#* [https://steamcommunity.com/sharedfiles/filedetails/?id=1510554297 Publisher Plus] is a mod that gives you the option to exclude certain files and folders for uploading.
 +
# Update your About folder, that thing was made in a hurry anyways. Add a nice Preview.png to showcase your mod:
 +
## A good preview will help garner interest in your mod. For Steam, your Preview.png can't be bigger than 1 MB. A resolution of 640x360 works best.
 +
## Make sure you've updated the supportedVersions tag.
 +
## Write a good description. A good description will have a sentence at the top stating what the mod does.<br/>
  
 
=Distribution=
 
=Distribution=
 +
==Steam==
 +
# Put your prepared folder in the '''Mods''' subfolder of your RimWorld installation.
 +
# Enable dev mode (You're a mod developer now, you should already have it enabled).
 +
# Press the Mods button. If you have dev-mode enabled, there will be a button labeled "Upload on Steam".
 +
## Once you've successfully uploaded the mod on Steam, there will be a new file called PublishedFileId.txt. It contains a long number like 1454024362 which is the unique ID for your workshop submission. This file is required to update your mod later. Only your Steam account can update the workshop submission with this number.<br/>
 +
# Set the visibility of your item. If you keep it hidden nobody will see it!
  
−
# Compile all your DLLs and make sure they're in the Assemblies folder;
+
===Common issues===
−
# Make a copy of your mod and call it (YourModName)-DEV or something along those lines. Strip all files standard users won't need out of the standard version:
+
* Your Preview.png can't be larger than 1MB in size.
−
## The Source folder is mostly useless for standard mod users;
+
* Your mod isn't a local folder.
−
## Backups of older versions of textures and such can be removed from the standard version;
+
* Dev mode not active.
−
## Make sure to remove as many XML comments as you want, don't leave spoilers in there for your upcoming updates!
+
* You are not logged in as the original author of the mod. This can happen when you're a contributor, or when the template mod you used had a pre-existing PublishedFileId.txt.
−
# Update your About folder, that thing was made in a hurry anyways. Add a nice Preview.png to showcase your mod:
+
** Make sure you are the original author and you're not re-uploading someone else's mod without permission.
−
## Make sure you've updated the targetVersion tag,
+
* Steam not running or initialised. Make sure you're logged in, there are no errors regarding Steam or Steamworks in the output_log (dev console doesn't always show these erros!) and that you can access the workshop.
−
# '''Optional:''' Release your source code.
+
* Steam (workshop) is down. Verify [https://downdetector.com/status/steam/map/ here].
−
## Some mods include the Source folder with the full C# project in it for other modders to check out;
+
* You have a [https://support.steampowered.com/kb_article.php?ref=3330-IAGK-7663 Limited User Account]. ''Limited user accounts are prevented from accessing several features on Steam, including but not limited to Submitting content on the Steam Workshop.'' Which is what uploading a mod is.
−
## Some mods include a Dropbox download link to their source code in the mod's topic. This is also a possibility,
+
 
 +
==GitHub==
 +
# If your mod has a GitHub repository, you can visit its https://github.com/YOURUSERNAME/YOURREPOSITORY/releases section to make a new release.
 +
## https://github.com/YOURUSERNAME/YOURREPOSITORY/releases/latest will always link to your latest release.<br/>
 +
 
 +
==General==
 +
# Some mods include a Dropbox download link to their source code in the mod's topic.
 
# Take a look at the "Mod release rules" {{LudeonThread|10561}};
 
# Take a look at the "Mod release rules" {{LudeonThread|10561}};
−
# Along with that, this {{LudeonThread|7037}} has tips on host sites and further naming conventions.<br/><br/>
+
# Along with that, this {{LudeonThread|7037}} has tips on host sites and further naming conventions.
 +
# While possible to add your mod as an attachment to your Ludeon thread, these attachments are severely limited in size (max. 600kB) and are regularly deleted. They are also only visible to logged in users.<br/><br/>
  
 
[[Category:Modding tutorials]]
 
[[Category:Modding tutorials]]

Latest revision as of 10:54, 8 February 2019

< Modding Tutorials

This tutorial suggests steps to take when releasing your mod.

Requirements[edit]

Preparation[edit]

  1. Compile all your DLLs and make sure they're in the Assemblies folder.
  2. Activate your mod. Test it. Your mod should not cause any errors, warnings or other logspam on startup.
  3. Recommended: Consider a license, preferably one that will let other modders update and expand upon your mod.
  4. Optional: Make a copy of your mod folder for release. This folder shouldn't contain files that aren't of interest to most users.
    1. Backups of older versions of textures and such can be removed from this folder.
    2. Your .git folder and the .vs and bin/obj folders made by your IDE/Visual Studio can be removed.
    • Publisher Plus is a mod that gives you the option to exclude certain files and folders for uploading.
  5. Update your About folder, that thing was made in a hurry anyways. Add a nice Preview.png to showcase your mod:
    1. A good preview will help garner interest in your mod. For Steam, your Preview.png can't be bigger than 1 MB. A resolution of 640x360 works best.
    2. Make sure you've updated the supportedVersions tag.
    3. Write a good description. A good description will have a sentence at the top stating what the mod does.

Distribution[edit]

Steam[edit]

  1. Put your prepared folder in the Mods subfolder of your RimWorld installation.
  2. Enable dev mode (You're a mod developer now, you should already have it enabled).
  3. Press the Mods button. If you have dev-mode enabled, there will be a button labeled "Upload on Steam".
    1. Once you've successfully uploaded the mod on Steam, there will be a new file called PublishedFileId.txt. It contains a long number like 1454024362 which is the unique ID for your workshop submission. This file is required to update your mod later. Only your Steam account can update the workshop submission with this number.
  4. Set the visibility of your item. If you keep it hidden nobody will see it!

Common issues[edit]

  • Your Preview.png can't be larger than 1MB in size.
  • Your mod isn't a local folder.
  • Dev mode not active.
  • You are not logged in as the original author of the mod. This can happen when you're a contributor, or when the template mod you used had a pre-existing PublishedFileId.txt.
    • Make sure you are the original author and you're not re-uploading someone else's mod without permission.
  • Steam not running or initialised. Make sure you're logged in, there are no errors regarding Steam or Steamworks in the output_log (dev console doesn't always show these erros!) and that you can access the workshop.
  • Steam (workshop) is down. Verify here.
  • You have a Limited User Account. Limited user accounts are prevented from accessing several features on Steam, including but not limited to Submitting content on the Steam Workshop. Which is what uploading a mod is.

GitHub[edit]

  1. If your mod has a GitHub repository, you can visit its https://github.com/YOURUSERNAME/YOURREPOSITORY/releases section to make a new release.
    1. https://github.com/YOURUSERNAME/YOURREPOSITORY/releases/latest will always link to your latest release.

General[edit]

  1. Some mods include a Dropbox download link to their source code in the mod's topic.
  2. Take a look at the "Mod release rules" Thread;
  3. Along with that, this Thread has tips on host sites and further naming conventions.
  4. While possible to add your mod as an attachment to your Ludeon thread, these attachments are severely limited in size (max. 600kB) and are regularly deleted. They are also only visible to logged in users.

Retrieved from "https://rimworldwiki.com/index.php?title=Modding_Tutorials/Distribution&oldid=62614"