Ludeon Forums

RimWorld => Mods => Releases => Topic started by: Evul on October 21, 2014, 09:18:03 PM

Title: Helpful info for publishing mods
Post by: Evul on October 21, 2014, 09:18:03 PM
This is just a post help you get started.

Host sites mods:
ModDB (http://www.moddb.com/games/rimworld/mods)
Nexus mods (http://www.nexusmods.com/rimworld/?) [Official Graphic: Download button (http://static-3.nexusmods.com/15/images/101/1-1394454241.png)]
Modsaholic (http://www.modsaholic.com/forums/index.php/files/category/135-rimworld/) [Official Graphic: Download button (http://www.modsaholic.com/forums/site_pics/downloadbut.png)]


Other file upload services:
Dropbox (https://www.dropbox.com)
*PM me and I add more

Topic name:
Follow the community standard so it is easy to know when a mod is outdated or not.
The current community standard and recommended format is:
[AlphaVersion] [Tag] ModName (ModVersion) Possible quote, message or date.

Example names:
[A19] The rose mod (2.1.2a) Give it away!
[A19] RimWorld red carpet mod (Version 2)
[A19] Lockable door mod (v1.30) (2020-10-11)
[A19] New animal boomrat
[A19] [ADDON] New animal boomrat - Blue colour.
[A19] [TEXTURE] White rose - Red roses or white, I bring white.

Current supported tags:
Sub-MOD or ADDON - A sub-mod is a modmod a mod on a mod.
TEXTURE - A pure texture replacement, nothing else.
MODPACK - A pack of mods and textures. Make sure you ask for permission befour making one.
MODLIST - An unofficial list of mods. (Please don't make more then one.)
*We will not stop you if you make a new one. As long as it is logical.

First post templates:
Pick the one you like the most or make your own. Copy the code and shape it to yours.
[center][size=20pt]HEAD[/size][/center]

[color=orange][size=18pt]Description:[/size][/color]
Your description and information of the mod.

[color=orange][b]Sub Topic[/b][/color]
More information about the mod.

[color=orange][size=18pt]Author/Mod Team[/size][/color]
You and other

[color=orange][size=18pt]Download[/size][/color]
Download link your links

[color=orange][size=18pt]How to install:[/size][/color]
- Unzip the contents and place them in your RimWorld/Mods folder.
- Activate the mod in the mod menu in the game.


*The templates are gathered from the most used formats on the board.

Note: When making your own; avoid making a entire topic in one bright sparkly colour and large letters, its just enoying. Its better to be clean but unique. Make your own subtopics in pictures or other creative ways.

RimWorldWiki:
When you have made your first post you might want to add your self to the RimWorldWiki mod List (http://rimworldwiki.com/wiki/mods)

FAQ:
Q: I can't remove my poll. How do I do this?
A: Send a PM to a moderator with a link to the topic with a poll.

Q: Can my mod or list of mods be pinned?
A: No. It will be unfair to other mod creators if the list or mod is pinned.

Q: Why are there mods from the previous alpha still in the release thread?
A: Mod threads are moved to outdated when the mod has been; inactive for 2 versions back, the user have been inactive for one version back after a new alpha have been released. Usually a cleaning starts after a new version of RimWorld is released.



Page is under edit it will be completed soon.
Title: Re: [HOST LINKS] Links to pages hosting rimworld mods
Post by: Iwillbenicetou on October 21, 2014, 09:31:19 PM
Especially Mod Data Base. It is easy, and popular. It also looks nice.

And as a side note, We should limit to what we pin... A bit annoying seeing 5 threads pinned. Just a bit annoying and it feels like everything will be pinned. Just a side note.
EDIT: don't wanna be annoying. :P
Plus, add a page to a website (Wiki maybe?) to where mod creators will publish their Idea's
Title: Re: [HOST LINKS] Links to pages hosting rimworld mods
Post by: Evul on October 22, 2014, 08:14:19 AM
If you was thinking on the tutorials on help i gonna make them in to one thread or try get them on to the wiki instead.

Also i don't pin unuseful stuff, will take a look what is currently pin and unpin it if its outdated. :)
Title: Re: [HOST LINKS] Links to pages hosting rimworld mods
Post by: Jaxxa on October 22, 2014, 08:28:08 PM
I think it could be helpful to have a list of mods on the Wiki.

Maybe for each Alpha have a table Grouped by mod type, then alphabetical order with the Name, Short 1 line description and link to the Forum thread.
Title: Re: [HOST LINKS] Links to pages hosting rimworld mods
Post by: Rikiki on October 23, 2014, 03:01:31 AM
So let's write an extract! :)

Name: M&Co. Deepdriller+MMS (https://ludeon.com/forums/index.php?topic=5930.0)
Description: provides several mining tools from the basic pneumatic pick to the automated deepdriller machine and mobile mineral sonar.
Requirements: M&Co. Common (must be activated before M&Co. Deepdriller+MMS).
Categories: resources gathering, tools, Tynan's genuine "Sci-fi western" theme-friendly
Tehnology level: midworld

Name: M&Co. Security enforcement (https://ludeon.com/forums/index.php?topic=6950.0)
Description: provides advanced security assets than can be manufactured: laser weapons with custom warmup animation.
Requirements: M&Co. Common (must be activated before M&Co. Security enforcement).
Categories: weapons, Tynan's genuine "Sci-fi western" theme-friendly
Tehnology level: spacer

I hope this pattern corresponds to what you wanted jaxxa! ;)
Title: Re: [HOST LINKS] Links to pages hosting rimworld mods
Post by: Evul on October 23, 2014, 10:32:19 AM
Been tried and done many times, the problem is to maintain it. It often ends up with the person first maintaining it drops of. But i can agree to some existent that some larger mods or projects could have a wiki page, or be mentioned on a wikipage.
Title: Re: [HOST LINKS] Links to pages hosting rimworld mods
Post by: Kubouch on October 23, 2014, 05:32:06 PM
Quote from: Evul on October 23, 2014, 10:32:19 AM
Been tried and done many times, the problem is to maintain it. It often ends up with the person first maintaining it drops of. But i can agree to some existent that some larger mods or projects could have a wiki page, or be mentioned on a wikipage.

I think plain listing of mods doesn't work. There were some efforts on the forum but it didn't really work for the reason you wrote. Maybe add a little form similar to Rikiki's ecample and let mod makers fill it - thus maintaining it themselves. Some statistics like mod downloads, endorsements and such would help to sort the mods and choose the best. Maybe a possibility to write a review.

What we need is a proper mod manager. There was one attempt, if I remember corectly, but ended in vain. Proper manager + integrated mod database => eternal pleasure of moddingness.
Title: Re: [HOST LINKS] Links to pages hosting rimworld mods
Post by: Evul on October 23, 2014, 05:34:20 PM
Due to early access on steam and how Tynan decide to develop the game the steam workshop might fix some problems :)
Also, about the little form yeah that could work, if mentioned. Cause some modders tend to do one or 4 modes then diaper. Then many reapear 3-5 alphas later.
Title: Re: [HOST LINKS] Links to pages hosting rimworld mods
Post by: Coenmcj on October 23, 2014, 07:36:24 PM
Quote from: Evul on October 23, 2014, 05:34:20 PM
Cause some modders tend to do one or 4 modes then diaper. Then many reapear 3-5 alphas later.

Go home Evul, you're drunk. :P

somewhat ontopic however, I'm hoping for the LudeonLauncher to have a modding tool with it.
Title: Re: [HOST LINKS] Links to pages hosting rimworld mods
Post by: Evul on October 24, 2014, 12:20:16 AM
Lol autocorrect

*Cause some modders tend to do one or 4 mods then disappear. Then many reappear 3-5 alphas later.

A launcher might do that. It would be neat.
Title: Re: [HOST LINKS] Links to pages hosting rimworld mods
Post by: Jaxxa on October 26, 2014, 10:02:41 PM
I was thinking to create a Wiki page and let each authors add their own mod to it.

That way there is no single person maintaining, if an Author does not want to he can simply not add it to the wiki.

Maybe have a new page for each alpha so it does not matter if they disappear, it just wont be on the new Alpha modlist page.
Title: Re: [HOST LINKS] Links to pages hosting rimworld mods
Post by: Evul on October 27, 2014, 08:49:07 AM
Suggestion layout:
http://www.ckiiwiki.com/Mods
Title: Re: [HELP] Publish a mod, help and FAQ
Post by: Evul on December 28, 2014, 12:02:01 PM
Updated the main topic to be a little bit more structure and helpful
Title: Re: [HELP] Publish a mod, help and FAQ
Post by: Igabod on December 30, 2014, 04:37:38 PM
I am interested to see those First Post templates that are not finished yet apparently. I have been struggling to find a decent format for mine and would definitely use a template if it is clean looking and includes all the necessary information spots.
Title: Re: [HELP] Publish a mod, help and FAQ
Post by: Evul on December 30, 2014, 05:19:02 PM
Oh forgot to add it xD Added one of them.
have not finished the other one.
I try to mix them with the current first post of the forum.

Quote
HEAD

Description:
Your description and information of the mod.

Sub Topic
More information about the mod.

Author/Mod Team
You and other

Download
Download link your links

How to install:
- Unzip the contents and place them in your RimWorld/Mods folder.
- Activate the mod in the mod menu in the game.
Title: Re: [HELP] Publish a mod, help and FAQ
Post by: Igabod on December 30, 2014, 06:35:21 PM
I took inspiration from the example you showed and made a modified version for my Xtra Plants mod thread. In the process I decided to create pictures with various words in Orange text. I wasn't happy with the orange that the forum color tags uses. Anyway, I figured I'd provide them here in case anybody wants to use these themselves and just don't feel like going to the trouble of actually making the pictures.

(http://i.imgur.com/0ZHWXe8.png)
(http://i.imgur.com/TdtCrpk.png)
(http://i.imgur.com/aQrCtX8.png)
(http://i.imgur.com/NjiNs6X.png)
(http://i.imgur.com/kOWbZeR.png)
(http://i.imgur.com/oz5e8oN.png)
(http://i.imgur.com/GcoWTfx.png)
Title: Re: [HELP] Publish a mod, help and FAQ
Post by: elStrages on January 12, 2015, 05:56:12 PM
Quote from: Igabod on December 30, 2014, 06:35:21 PM
I took inspiration from the example you showed and made a modified version for my Xtra Plants mod thread. In the process I decided to create pictures with various words in Orange text. I wasn't happy with the orange that the forum color tags uses. Anyway, I figured I'd provide them here in case anybody wants to use these themselves and just don't feel like going to the trouble of actually making the pictures.

(http://i.imgur.com/0ZHWXe8.png)(http://i.imgur.com/TdtCrpk.png)(http://i.imgur.com/aQrCtX8.png)(http://i.imgur.com/NjiNs6X.png)(http://i.imgur.com/kOWbZeR.png)(http://i.imgur.com/oz5e8oN.png)(http://i.imgur.com/GcoWTfx.png)
are you saying save and re upload to add to your mod or can we use your imgur link
if the latter then post your code dude ;)
Title: Re: [HELP] Publish a mod, help and FAQ
Post by: Igabod on January 14, 2015, 09:13:39 PM
Quote from: elStrages on January 12, 2015, 05:56:12 PM
are you saying save and re upload to add to your mod or can we use your imgur link
if the latter then post your code dude ;)

Do it however you like. If you want to use the imgur images directly then here they are.

(http://i.imgur.com/0ZHWXe8.png)
[img]http://i.imgur.com/0ZHWXe8.png[/img]

(http://i.imgur.com/TdtCrpk.png)
[img]http://i.imgur.com/TdtCrpk.png[/img]

(http://i.imgur.com/aQrCtX8.png)
[img]http://i.imgur.com/aQrCtX8.png[/img]

(http://i.imgur.com/NjiNs6X.png)
[img]http://i.imgur.com/NjiNs6X.png[/img]

(http://i.imgur.com/kOWbZeR.png)
[img]http://i.imgur.com/kOWbZeR.png[/img]

(http://i.imgur.com/oz5e8oN.png)
[img]http://i.imgur.com/oz5e8oN.png[/img]


(http://i.imgur.com/GcoWTfx.png)
[img]http://i.imgur.com/GcoWTfx.png[/img]
Title: Re: [HELP] Publish a mod, help and FAQ
Post by: yokai on February 16, 2015, 04:29:08 PM
I have a stupid question, how can i pin my pictures form my pc to the board??? I am new in such things  :-[
Title: Re: [HELP] Publish a mod, help and FAQ
Post by: Igabod on February 16, 2015, 05:49:55 PM
Quote from: yokai on February 16, 2015, 04:29:08 PM
I have a stupid question, how can i pin my pictures form my pc to the board??? I am new in such things  :-[

Go to www.imgur.com and upload your pictures there. Then once they are uploaded, you will see a little box to the right with a bunch of different versions of links for it. The one you want is the BBC code link, it will look like

[img]http://i.imgur.com/0ZHWXe8.png[/img]

or something like that. You just copy that whole thing and paste it in to the box where you type.
Title: Re: [HELP] Publish a mod, help and FAQ
Post by: yokai on February 17, 2015, 03:47:15 AM
Thank you very much Igabod, now i can write better boardposts  ;D
Title: Re: [HELP] Publish a mod, help and FAQ
Post by: eberkain on April 09, 2015, 02:20:06 PM
I would like to request that the template in the first post gets an added section on compatibility, I, and I'm sure many others, would greatly appreciate a few words from the mod author on what exactly the mod changes and what is going to be compatible with or not compatible with.  Its very difficult to get a good idea if a mod will work with your other mods currently, and I see alot of posts in alot of different threads that simply say, "Will this work with X?"
Title: Re: [HELP] Publish a mod, help and FAQ
Post by: Igabod on April 09, 2015, 03:58:13 PM
Quote from: eberkain on April 09, 2015, 02:20:06 PM
I would like to request that the template in the first post gets an added section on compatibility, I, and I'm sure many others, would greatly appreciate a few words from the mod author on what exactly the mod changes and what is going to be compatible with or not compatible with.  Its very difficult to get a good idea if a mod will work with your other mods currently, and I see alot of posts in alot of different threads that simply say, "Will this work with X?"

Almost all mods are compatible with everything except a few rare mods and any of the medical mods. Most of the modders are careful about that exact issue and will either make the mod so that it can't be incompatible with anything or there will already be a notification within the original post for that mod stating that it isn't compatible with such-and-such mod. A lot of what some people are calling compatibility issues are simply just mod order issues.
Title: Re: HELP: Publish a mod, help and FAQ
Post by: Alistaire on June 16, 2015, 07:34:13 AM
Quote from: Evul on October 21, 2014, 09:18:03 PM
Topic name:
Follow the community standard so it is easy to know when a mod is outdated or not.
The current community standard and recommended format is:
[AlphaVersion] (Tag) ModName (ModVersion) Possible quote, message or date.

Exsample names:
[A19] The rose mod (2.1.2a) Give it away!
[A19] RimWorld red carpet mod (Version 2)
[A19] Lockable door mod (v1.30) (2020-10-11)
[A19] New animal boomrat
[A19] (ADDON) New animal boomrat - Blue colour.
[A19] (TEXTURE) White rose - Red roses or white, I bring white.

Current supported tags:
MOD - Mod are a mod.. It changes or add material in the game or something else fantasy stops you.
Sub-MOD - A sub-mod is a modmod a mod on a mod.
TEXTURE - A pure texture replacement, nothing else.
MODPACK - A pack of mods and textures. Make sure you ask for permission befour making one.
MOD LINKS - An unofficial list of mods. (Please don't make more then one.)
*We will not stop you if you make a new one. As long as it is logical.

    This "community standard" is convoluted to the point where the examples don't follow the guidelines;

>> [A19] Lockable door mod (v1.30) (2020-10-11)
While []'s and ()'s are important in the "community standard"'s format, apparently date (without brackets) has to
be between brackets?


>> [A19] New animal boomrat
I'm not sure "New animal boomrat" is the mod's name, and I'm also not sure why it doesn't have a version.

>> [A19] (ADDON) New animal boomrat - Blue colour.
Once again no version. It has a (Tag) which is cool but it's not a "supported tag" so it's ultimately useless according
to the "community standard".


>> [A19] (TEXTURE) White rose - Red roses or white, I bring white.
Once again not a version, and THE ONLY EXAMPLE with a "supported tag".




    I get you're updating it, but the examples haven't followed the guidelines they're an example of for a while now.
Another thing is that the forum supports these small icons on forum posts, even though they really don't mean
anything at the moment. One might wonder if it's possible to add new icons to differentiate between (MOD) and
(Sub-MOD), (MOD LINKS) and (MODPACK).
Title: Re: HELP: Publish a mod, help and FAQ
Post by: RemingtonRyder on June 24, 2015, 11:01:52 AM
Just so you know, to make it easier to search for mods which are Alpha 10 or 11, the moderation team is now enforcing use of square brackets around the short version of the game version it targets e.g. [A11]

This is per Evul's post here (http://ludeon.com/forums/index.php?topic=13766.0).

Note that searching will also locate individual posts which include the tag, so if you are maintaining a modlist which aren't all updated for the latest version, you can use it to distinguish them. Obviously though, topics with a tag in the title appear first in the search results.

Also, the [MOD] tag is not required any more and will be removed, it's the mods subforum after all. ;)
Title: Re: HELP: Publish a mod, help and FAQ
Post by: JerryBi on June 29, 2015, 08:20:50 AM
Maybe litle adjusting to forum engine will give big benefit?

For SMF exist nice addon that give sorting by TAGS.
Then you create thread - you select needed TAGS like

[A11][MOD] mod name [1.12][01.01.2015]

and someone other can simply choose gameversion and say only texture packs,
only them will be sorted out for comfortable view

Link to existing solution http://mods.simplemachines.org/index.php?mod=579
Title: Re: Helpful info for publishing mods
Post by: maculator on September 08, 2017, 12:19:11 PM
Adding the mod to the modlist should be mandatory. Coming back after some time and having to go through the whole forums to find your mods is a pain.
Title: Re: Helpful info for publishing mods
Post by: svc_bot on November 18, 2017, 05:50:18 AM
Since the newest version of the game is called Beta 18, should the new naming convention be something like [B18], or should we stick to the old convention [A18]? I see that people are using both, but I think it would be better if we decide to use one for consistency reasons.
Title: Re: Helpful info for publishing mods
Post by: Canute on November 18, 2017, 06:44:25 AM
B18 should be the correct one now.
Before today of the release it was called A18 unstable. Only today we non devs got notified that isn't Alpha anymore.
Thats why you see A18 and B18 tags.
Title: Re: Helpful info for publishing mods
Post by: RemingtonRyder on November 18, 2017, 08:45:46 AM
Speaking of B18, I can't wait for B19 to come around because on this forum the B and the 8 look really similar. :P
Title: Re: Helpful info for publishing mods
Post by: Nightinggale on November 30, 2017, 12:11:37 AM
Quote from: MarvinKosh on November 18, 2017, 08:45:46 AM
Speaking of B18, I can't wait for B19 to come around because on this forum the B and the 8 look really similar. :P
When this baby hits B8, you are going to see some serious s... well some users will be in medieval times, some in industrial times and some in space age   8)