How to use Custom Event Loader

To install the Custom Event Loader mod, place the downloaded dll file in the "Bepinex\plugin" folder as usual. After that, you need to create a folder to store all the custom event files. 

 

The default folder path is "CustomEvent", you can change it if you want to place it elsewhere. Press F1 to open the ConfigurationManager and edit the path there. 

All the custom event zip files should be placed inside that folder. You can create sub folders there if you want to keep things in your way. The mod will scan through all files in all sub directories so no worry.

In the main daily screen, a button is added for custom events. It is separated from the official event button so you do not have to worry about searching the custom events in that long official event list.

As I mentioned before I am not a mod collector, so I am not sure if the injected button overlaps with the buttons by other mods. If it is the case please let me know and I will update the position.

 

 

The above screen is shown if you clicked the "Custom Event" button. It reuses the event screen but will only load the content from the custom event folder.

 

(1) The List of event, same as the official event screen. 
    
*Note that the order of this event list is ordered by file names in the custom event folder. This means you can reorder it yourselve to put your favourite one in the top by renaming the zip files.

 

(2) Originally this is the list to select the maid participated. In this mod the maids selected are in the next screen, so this part is always empty.

 

(3) The description of the event, provided by the event creators. 

 

(4) The extra information about this event. Now it is showing the author, the language used and number of maids required. There is no condition for executing custom events so you dont have to worry about it (I am just too lazy to change that header).

 

 

When you have selected an event, the above screen will be shown. This is the maid selection screen. You need to select all the maids required according to the requirement of the event description file.

 

(1) The list of the maids. For each events, the creator need to define how many maids needed and the corresponding personality required. The mod has done the filtering for you so you can select those who are not darkened.

 

(2) The list of selected maids. If you click on the name plate here, you deselect the maid and the mod will ask you to select the maid again. 

 

(3) Show the information of your selection process. Originally I want to show what kind of personality required but there is not enough space and I dont want to add extra UI. 

If you have selected all the maids required, the text here will change to "Ready to go".

 

(4) Once you have selected all the maids required, you can click OK to start the custom event! 

 

And then it is the time for enjoying the custom event!