Room Girl/Modding - Revision history

SpockBauru: updated Installing Bepinex

2023-01-06T20:22:13Z

updated Installing Bepinex

SpockBauru at 19:33, 6 January 2023

2023-01-06T19:33:29Z

SpockBauru at 19:25, 6 January 2023

2023-01-06T19:25:00Z

SpockBauru at 19:20, 6 January 2023

2023-01-06T19:20:36Z

SpockBauru at 19:15, 6 January 2023

2023-01-06T19:15:28Z

SpockBauru: Added BepInEx and HF-Patch sections

2023-01-06T19:10:53Z

Added BepInEx and HF-Patch sections

SpockBauru: Fixed URL

2023-01-03T17:57:03Z

Fixed URL

SpockBauru: Added Modding Room Girl

2023-01-03T17:22:52Z

Added Modding Room Girl

Blubberdiblub: Changed "previews" to "previous", because that's the intended meaning

2022-10-06T17:18:52Z

Changed "previews" to "previous", because that's the intended meaning

SpockBauru: Created Modding

2022-09-26T17:45:35Z

Created Modding

New page

{{Room_Girl}}=Introduction to MODs=
'''MODs''' it’s a short for "modifications", with them you can introduce new features to the game such as new functions, parameters, clothes and hairstyle.

There are several types of mods. One of them is called '''Plugins''' which can alter the game code. They are usually files with .dll extension and must be applied with extra care.

Please understand that modifying your game is risky by nature and requires some safeguards such as '''backing up the game data'''. Also always read carefully what each thing does before using it.

=Difficulties on Room Girl Modding comparing to previews games=
Let's start from the beginning: Games usually are made in programs called '''Engines''', like Unreal and Unity. Illusion games uses the '''Unity Engine'''.

When making a game, game makers need to program two things in the Engine: The '''CPU''' (AKA the processor) and the '''GPU''' (AKA the video card).

In order to make Plugins, modders use "mod frameworks", such as BepInEx and MelonLoader. In the last years, Illusion modders uses '''BepInEx''', which is specialized in Unity Engine. Plugins must follow the structure used by the mod framework, the game maker and the engine for both CPU and GPU in order to work.

Since Illusion usually use the same engine with similar settings and re-uses their code across games, many plugins can easily be ported between these games. That's why late games such as [[Honey Select 2]] have a huge amount of mods: Because modders had time to refine their mods across several years and games, for both the CPU and the GPU programming.

But differently from previews games Room Girl changed two things: How the engine deals with CPU, and from the GPU side they not only changed the engine settings but remade all the code that program the GPU (also called shaders).

* For the CPU side, take a look on "The problem with IL2CPP" section bellow.

* For the GPU side, take a look on the HDRP section bellow.

== The problem with IL2CPP ==
Unity uses a language called C# (reads C sharp) to make programs for the games. These programs must be converted to machine language in order to run in the computer. This conversion is made by the Scripting Backend. In recent year Unity has two types of scripting backends: Mono and IL2CPP.

* '''Mono''' is the old one. To simplify things, let’s say that it uses a virtual machine between the C# code and the hardware. With this approach, you can write the same code, and Unity can change just the virtual machine to run in many platforms, like videogames, smarthphones, PC, etc. This is a mature technology and is used by BepInEx to change the game code. This is the one that previews Illusion games used.

* '''IL2CPP''' is the new one, it means “Intermediate Language to C++”. IL2CPP takes the C# code and convert directly to the C++ native language skipping the “virtual machine” part, which theoretically make the game runs faster. This is the one that Room Girl uses.

The problem with IL2CPP technology is that BepInEx support is new and unstable. Not only this but the approach for modifying the code must be different from the old thing, '''MAKING ALL PREVIOUS PLUGINS INCOMPATIBLE WITH ROOM GIRL'''.

Because of that, all the numerous and refined structure made by modders trough the years need to be ported, one by one, set by step, from the very beginning. This takes time, and by the time that everything catches up, probably the next game will already be released.

== HDRP ==
Unity deals with the graphics part using the so-called Render Pipelines. Currently there 3 of them: the Standard Render Pipeline, the Universal Render Pipeline (URP) and the High Definition Render Pipeline (HDRP).

* The '''Standard''' Render Pipeline is the oldest and the one used in previews Illusion games. Is also set to be depreciated in the future, so someday game makers will have to choose between the other two.

* The Universal Render Pipeline ('''URP''') will be the replacement for the Standard in the future. It’s made to be basic, lightweight and highly portable across a huge amount of platforms, from old mobile to next gen consoles.

* The High Definition Render Pipeline ('''HDRP''') is the most advanced of all. It’s designed to make the better graphics possible and run on high performant platforms like high-end PCs and next gen consoles. Take a look on this tech demo to see what is possible with HDRP: https://www.youtube.com/watch?v=eXYUNrgqWUU

Both URP and HDRP are completely incompatible with the old Standard pipeline. For Room Girl Illusion choose the HDRP and had to remake all their graphics programming, like shaders. For modders, the change to HDRP means that the graphics plugins (such as Material Editor, DHH and Graphics mod) will not work at all and can’t even be ported: They need to be remade from scratch.

== TL:DR ==
In a short: Room Girl bring so many changes that plugins will take a long, looooong time to catch up comparing to the previews game. It’s likely that will never reach the same level of [[Koikatu]] or [[Honey Select 2]]

@@ Line 74: / Line 74: @@
 After installing, start RoomGirl with the internet activated so the rest of the needed files are downloaded. This process may take take up to 10 minutes depending on your system and internet speeds.<br>
 After successfully started the game for the first time, close the game and open the file <code>BepInEx.cfg</code> that is inside <code>BepInEx\config</code> with notepad. Change the value of "UnhollowedAssembliesPath" to <code>UnhollowedAssembliesPath = {BepInEx}/Unhollowed/{ProcessName}</code>.<br>
-To configure Studio, copy the files <code>winhttp.dll</code> and <code>doorstop.ini</code> from the Game Folder to the Studio folder.<br>
+To configure Studio, copy the files <code>winhttp.dll</code>, <code>doorstop_config.ini</code> and the folder <code>mono</code> from the Game Folder to the Studio folder.<br>
-In the Studio folder, open <code>doorstop.ini</code> with notepad and replace the line <code>targetAssembly=\BepInEx\core\BepInEx.IL2CPP.dll</code> with <code>targetAssembly=..\BepInEx\core\BepInEx.IL2CPP.dll</code> (yeah, the difference is just two dots...)
+In the Studio folder, open <code>doorstop_config.ini</code> with notepad and replace the line <code>targetAssembly=\BepInEx\core\BepInEx.IL2CPP.dll</code> with <code>targetAssembly=..\BepInEx\core\BepInEx.IL2CPP.dll</code> (yeah, the difference is just two dots...)
 === Needed Plugins ===

@@ Line 55: / Line 55: @@
 == HF-Patch ==
-By far the easiest way to install mods in a vanilla game is by using HF Patch. This package includes all free illusion DLCs, the base mods and essential plugins. Also, the extra plugins are cautiously selected to not generate any conflicts.<br>
+By far the easiest way to install mods in a vanilla game is by using HF Patch. This package includes all free illusion DLCs, the base mods and recommended plugins. Also, the experimental plugins are cautiously selected to not generate any conflicts.<br>
 To download HF Patch, copy the magnet link and paste in qBittorrent: https://github.com/ManlyMarco/RG-HF_Patch/releases/<br>

@@ Line 58: / Line 58: @@
 To download HF Patch, copy the magnet link and paste in qBittorrent: https://github.com/ManlyMarco/RG-HF_Patch/releases/<br>
-Install HF Patch in the Game Folder.
+Install in the Game Folder.
 == Main Game and Studio mods ==

@@ Line 86: / Line 86: @@
 == 100% Save File ==
-Unlock the Extra Free-H mode, including all the maps in the game, and all the different positions. Place this global.ila file in your {RoomGirl Folder}\UserData\save. <nowiki>https://cdn.discordapp.com/attachments/993990510018568272/1044415926541500456/global.ila</nowiki>
+Unlock the Extra Free-H mode, including all the maps in the game, and all the different positions. Place this global.ila file in <code>UserData\save</code>. <nowiki>https://cdn.discordapp.com/attachments/993990510018568272/1044415926541500456/global.ila</nowiki>
 == Recommended Plugins ==

@@ Line 56: / Line 56: @@
 == HF-Patch ==
 By far the easiest way to install mods in a vanilla game is by using HF Patch. This package includes all free illusion DLCs, the base mods and essential plugins. Also, the extra plugins are cautiously selected to not generate any conflicts.<br>
 To download HF Patch, copy the magnet link and paste in qBittorrent: https://github.com/ManlyMarco/RG-HF_Patch/releases/<br>

@@ Line 53: / Line 53: @@
 # Use the program [https://www.qbittorrent.org/download.php qBittorrent] to download torrent files, don’t use others like uTorrent because it may have issues with the tracker we use.
 # Run the game with the internet activated, specially in the first time when the game will take several minutes to load.
 == Main Game and Studio mods ==
-In Room Girl, the Main Game and the Studio are like complete separated entities. Because of that '''every plugin from the main game must be copied to the Studio folder'''.
+In Room Girl, the Main Game and the Studio are like complete separated entities. Because of that '''you need to configure BepInEx properly!!!'''. See the section bellow for more information.
 == Base Plugins ==
@@ Line 64: / Line 69: @@
 These mods are the very base to all plugins to work. Be careful with them. Read carefully each site before downloading.
-After installing BepInEx (the most important) you will need to launch the game with the internet activated, so it can download the rest of the requirements for the game. It can take up to 10 minutes depending on you system and internet speed.
+=== Installing BepInEx ===
-#BepInEx: The base of everything. All plugins rely on him to work. Install <code>BepInEx_UnityIL2CPP_x64_6.0.0-pre.1.zip</code>. Link: <nowiki>https://github.com/BepInEx/BepInEx/releases/tag/v6.0.0-pre.1</nowiki>
+#IllusionFixes: Fixes the issue that makes Studio hangs on startup. Download <code>IllusionFixes_IL2CPP</code> (some antivirus may report a false positive) <nowiki>https://github.com/IllusionMods/IllusionFixes/releases</nowiki>
 #XUnity.AutoTranslator: Translate the game texts. Uses human translations if available, otherwise use GoogleTranslator. Download the BepInEx IL2CPP version (XUnity.AutoTranslator-BepInEx-IL2CPP). <nowiki>https://github.com/bbepis/XUnity.AutoTranslator/releases</nowiki>
 == Translations ==

@@ Line 79: / Line 79: @@
 == Recommended Plugins ==
 * BepInEx Utility: Several quality-of-life improvements for BepInEx games. <nowiki>https://github.com/SpockBauru/SpockPlugins_BepInEx/releases</nowiki>
-* IllusionLaunchers: English Launcher with basic configuration. Click in "Show all assets" and download <code>IllusionLaunchers_RoomGirl</code>
+* IllusionLaunchers: English Launcher with basic configuration. Click in "Show all assets" and download <nowiki>https://github.com/IllusionMods/IllusionLaunchers/releases</nowiki>
 * Gravure plugin: Press "G" in the Character Maker to see extra options to show the girl. Download the DLL (some antivirus may report a false positive) and copy in <code>BepInEx\plugins</code>. <nowiki>https://cdn.discordapp.com/attachments/993990510018568272/994947577965461616/Gravure.dll</nowiki>
 * Maker Screenshot Plugin: Capture screenshot in Character Creator using Room Girl's built-in screenshot function. <nowiki>https://github.com/kkykkykky/MakerScreenShot/releases</nowiki>

@@ Line 24: / Line 24: @@
 Unity uses a language called C# (reads C sharp) to make programs for the games. These programs must be converted to machine language in order to run in the computer. This conversion is made by the Scripting Backend. In recent year Unity has two types of scripting backends: Mono and IL2CPP.
-* '''Mono''' is the old one. To simplify things, let’s say that it uses a virtual machine between the C# code and the hardware. With this approach, you can write the same code, and Unity can change just the virtual machine to run in many platforms, like videogames, smarthphones, PC, etc. This is a mature technology and is used by BepInEx to change the game code. This is the one that previous Illusion games used.
+* '''Mono''' is the old one. To simplify things, let’s say that it uses a virtual machine between the C# code and the hardware. With this approach, you can write the same code, and Unity can change just the virtual machine to run in many platforms, like videogames, smartphones, PC, etc. This is a mature technology and is used by BepInEx to change the game code. This is the one that previous Illusion games used.
 * '''IL2CPP''' is the new one, it means “Intermediate Language to C++”. IL2CPP takes the C# code and convert directly to the C++ native language skipping the “virtual machine” part, which theoretically make the game runs faster. This is the one that Room Girl uses.
@@ Line 45: / Line 45: @@
 == TL:DR ==
 In a short: Room Girl bring so many changes that plugins will take a long, looooong time to catch up comparing to the previous game. It’s likely that will never reach the same level of [[Koikatu]] or [[Honey Select 2]]

@@ Line 6: / Line 6: @@
 Please understand that modifying your game is risky by nature and requires some safeguards such as '''backing up the game data'''. Also always read carefully what each thing does before using it.
-=Difficulties on Room Girl Modding comparing to previews games=
+=Difficulties on Room Girl Modding comparing to previous games=
 Let's start from the beginning: Games usually are made in programs called '''Engines''', like Unreal and Unity. Illusion games uses the '''Unity Engine'''.
@@ Line 15: / Line 15: @@
 Since Illusion usually use the same engine with similar settings and re-uses their code across games, many plugins can easily be ported between these games. That's why late games such as [[Honey Select 2]] have a huge amount of mods: Because modders had time to refine their mods across several years and games, for both the CPU and the GPU programming.
-But differently from previews games Room Girl changed two things: How the engine deals with CPU, and from the GPU side they not only changed the engine settings but remade all the code that program the GPU (also called shaders).
+But differently from previous games Room Girl changed two things: How the engine deals with CPU, and from the GPU side they not only changed the engine settings but remade all the code that program the GPU (also called shaders).
 * For the CPU side, take a look on "The problem with IL2CPP" section bellow.
@@ Line 24: / Line 24: @@
 Unity uses a language called C# (reads C sharp) to make programs for the games. These programs must be converted to machine language in order to run in the computer. This conversion is made by the Scripting Backend. In recent year Unity has two types of scripting backends: Mono and IL2CPP.
-* '''Mono''' is the old one. To simplify things, let’s say that it uses a virtual machine between the C# code and the hardware. With this approach, you can write the same code, and Unity can change just the virtual machine to run in many platforms, like videogames, smarthphones, PC, etc. This is a mature technology and is used by BepInEx to change the game code. This is the one that previews Illusion games used.
+* '''Mono''' is the old one. To simplify things, let’s say that it uses a virtual machine between the C# code and the hardware. With this approach, you can write the same code, and Unity can change just the virtual machine to run in many platforms, like videogames, smarthphones, PC, etc. This is a mature technology and is used by BepInEx to change the game code. This is the one that previous Illusion games used.
 * '''IL2CPP''' is the new one, it means “Intermediate Language to C++”. IL2CPP takes the C# code and convert directly to the C++ native language skipping the “virtual machine” part, which theoretically make the game runs faster. This is the one that Room Girl uses.
@@ Line 35: / Line 35: @@
 Unity deals with the graphics part using the so-called Render Pipelines. Currently there 3 of them: the Standard Render Pipeline, the Universal Render Pipeline (URP) and the High Definition Render Pipeline (HDRP).
-* The '''Standard''' Render Pipeline is the oldest and the one used in previews Illusion games. Is also set to be depreciated in the future, so someday game makers will have to choose between the other two.
+* The '''Standard''' Render Pipeline is the oldest and the one used in previous Illusion games. Is also set to be depreciated in the future, so someday game makers will have to choose between the other two.
 * The Universal Render Pipeline ('''URP''') will be the replacement for the Standard in the future. It’s made to be basic, lightweight and highly portable across a huge amount of platforms, from old mobile to next gen consoles.
@@ Line 44: / Line 44: @@
 == TL:DR ==
-In a short: Room Girl bring so many changes that plugins will take a long, looooong time to catch up comparing to the previews game. It’s likely that will never reach the same level of [[Koikatu]] or [[Honey Select 2]]
+In a short: Room Girl bring so many changes that plugins will take a long, looooong time to catch up comparing to the previous game. It’s likely that will never reach the same level of [[Koikatu]] or [[Honey Select 2]]