Store Page
RimWorld
All Discussions Screenshots Artwork Broadcasts Videos Workshop News Guides Reviews

RimWorld

Store Page
RimWorld >  Workshop > these people's Workshop
335 ratings
Custom Ritual Framework
Description Discussions0 Comments146 Change Notes
2
2
2
2
   
Award
Favorite
Favorited
Unfavorite
Mod, 1.3, 1.4, 1.5
File Size
Posted
Updated
22.838 MB
30 Jul, 2021 @ 3:33pm
15 Jul @ 3:58pm
37 Change Notes ( view )
Required DLC
This item requires all of the following DLC
RimWorld - Ideology
Created by
these people
Offline
Nin
Offline
Zezz
Offline
twsta
Offline
See all 5784 collections created by these people and other people (some may be hidden)
32,789 Unique Visitors
18,007 Current Subscribers
1,424 Current Favorites
You need DLC to use this item.

Subscribe to download
Custom Ritual Framework

In 1 collection by these people
Custom Ritual Framework and new Rituals
7 items
Description
A currently new but growing framework for creating custom Ideology rituals and outcomes fully-definable with XML.


Background

Originally envisioned to support rituals that ensure bountiful harvests and call manna from heaven, I quickly wanted to make those more generic and so provided a framework through which it is relatively easy to add additional RitualAttachableOutcomeEffects. This grew out from that, adding similar functionality to RitualOutcomeEffects for defining new rituals, and then eventually expanding to add other new classes and modExtensions to support further customization of new rituals. It has become a general Custom Ritual Framework.

Most of the Attachable Outcomes and both of the new Rituals are used to showcase the features and as examples. The XML files for them have been commented as a kind of tutorial in creating new outcomes and new rituals in general.



FAQ

Q: So how do I create new rituals and outcomes?
A: Check out the XML files included in this pack. They are commented to help provide guidance, and easily obtained from Github (see below). Also check out the Github Wiki!

Q: I found a bug, how do I report it?
A: There are surely some issues, so please bring them up! An easy way to do that is in the #bug-reports channel of the Discord, linked below.

Q: How can I help?
A: If you'd like to help expand the framework, the best way to start is to head on to the Discord and post in the #collaborators channel.



Links

Now with some sample rituals outside of this modpack, for ease of enabling/disabling: https://steamproxy.com/sharedfiles/filedetails/?id=2579343852





Additional Credits

Nin - Testing and design
kippetje2000 - Icons
twsta - Adoption ritual and enhancements to the Framework to support it
146 Comments
< >
(≡◉‿‿◉≡) 18 Dec @ 3:42am 
I wish someone would create a ritual that transforms a baseliner to a preferred xenotype :)
these people  [author] 13 Nov @ 9:41am 
@MerlinCross Yes! That would be pretty easy. Remember that these ritual rewards are only an example, and if you download the Sample Rituals you can see how to create an entirely new ritual. Remember this was intended to be a way for you to create your own rituals, and you can add as many rituals (or ritual rewards) as you like.

For everyone else: I've somewhat lost track of where I'm at and what I'm still supposed to be tracking for future updates. Post-health issues I have since been putting a lot of my effort into improving and maintaining my physical and mental health, sorry this journey has been taking me a lot more than I expected
MerlinCross 11 Nov @ 3:01pm 
Would it be possible to set up a selection of Trait adding Rituals? By that I mean 1 Ritual gives you Ascetic and another gives you Fast Walker? As it is, seems you can only make the Ritual Reward give only 1 hard locked trait that you need to go in and edit.
kongkim 1 Oct @ 2:51am 
Yah would love a fix for the thisn @Yoann is talking about :)
Yoann 28 Sep @ 2:37pm 
I'm playing with Research Data Theory and I'm running into 2 small problems:
_My researcher who performs the ritual gains social skill (it's a ritual performed alone), no gain or gain intellectual skill would be more relevant. There is already a way to change it?
_The reward seems to can't spawn under overhead mountain roof, I guess it's because it use the drop pod code?
these people  [author] 15 Sep @ 3:29pm 
@Yoann - sorry about that, I thought I had removed those rituals from the base and only kept them in Sample Rituals. I'll take a look at that when I can! But your save file should be fine, particularly if you are not using any of those rituals/outcomes in your Ideology. There might be some auto-generated Ideologies that use them, but you can safely just ignore those. Pawns will never attempt to autonomously run rituals. (Unless that was added in another update or by another mod)
Yoann 15 Sep @ 3:09pm 
I added this framework (required by another mod) without thinking it will comes with content, I thought the content was only in 'Sample Rituals'.
I understood from what the harvest bonus hediff and the big number of Go frenzy inspirations came when I reformed my ideology...

I guess I should have read better, but it's a bit strange to get stuff added like "adds a trait (Ascetic for this example) to pawns involved in the ritual", "this outcome is mostly used to test and showcase features" or outcomes who add psylink and ascetic trait...

I edited the rituals in my curent save before deleting the Defs files to keep only assemblies. I got one red error about RandomBuffPerPawn with many yellows errors, then nothing when I loaded my savegame a second time.
My savegame is safe or I'm better start a new game?

Thank you for the framework anyway
Kalmorph 2 Sep @ 8:37pm 
I think it's the kind of little detail that lot of people think it's not that useful or desired, but once they try it out, they can't play without it. I'm sure the game has a somewhat base behaviour you could analyse the code or reuse in some form, like marriages (once the event start, people often gather up first after a while that the event actually start). Anyways, glad this is of your interest as I find that very aligned with your ideas for the mod, I wish I was coder so I could help it out, but it may take a while before I take big feats such as these.
these people  [author] 2 Sep @ 6:15pm 
@Kalmorph Ahh that's a misinterpretation of scheduling. That was about how certain rituals would have triggers to be run on specific days. It'd be a bit of effort to add that kind of functionality and I still haven't quite gotten back into the swing of working on anything outside of my day job. But I'll put that on the list!
Kalmorph 2 Sep @ 5:53pm 
As an example, most of rituals takes 2 ingame hours, so I could set an ritual to start at 10pm (22h) so the event end up exactly at 00h, and everybody would start gethering in ritual room once it's 9:30pm