+++-이전 연재.
https://gall.dcinside.com/board/view/?id=rlike&no=484437&page=2
https://gall.dcinside.com/board/view/?id=rlike&no=484443
저번 화에서 우리는 CanSleep(); 을 수정하면 목적을 달성할 수 있을 것이라는 이야기를 했다.
이번 연재에서는 모드 개발에 필요한 종속성과 Harmony 라이브러리를 이용해서 패치하는 법을 다룬다.
7. 종속성 세팅.
먼저 플러그인 프로젝트를 만드는 방법에 대해서 알아보자.
+새 프로젝트 만들기를 하면 이런 화면이 뜰텐데 "클래스 라이브러리"를 택한다.
그 뒤에는 원하는 프로젝트명과 솔루션 이름을 정한다.
나는 DcMod로 하겠다.
프레임워크는 netstandard2.0을 선택한다.
다른 가이드에서는 .netframework 4.7.2를 쓰라고 하는데, 걱정말고 일케 쓰자.
드디어 프로젝트 창이 나왔다. 이제 종속성을 추가해주자.
우리가 추가해야할 종속성은 Elin 게임 폴더 내부에 있는 라이브러리들이다.
우측 메뉴에서 프로젝트를 클릭하면, 위와 같이 프로젝트 설정이 나온다.
일단 아래의 코드를 <Project> 안에 붙여넣자.
<!-- 기존의 ItemGroup 같은 경우에는 전부 밀어버려도 무관하다.-->
<!-- HintPath의 경로는 본인이 Elin을 설치한 폴더에서 참조한다.-->
<ItemGroup>
<Reference Include="0Harmony">
<HintPath>C:\Program Files (x86)\Steam\steamapps\common\Elin\BepInEx\core\0Harmony.dll</HintPath>
<Private>False</Private>
</Reference>
<Reference Include="BepInEx.Core">
<HintPath>C:\Program Files (x86)\Steam\steamapps\common\Elin\BepInEx\core\BepInEx.Core.dll</HintPath>
<Private>False</Private>
</Reference>
<Reference Include="BepInEx.Unity">
<HintPath>C:\Program Files (x86)\Steam\steamapps\common\Elin\BepInEx\core\BepInEx.Unity.dll</HintPath>
<Private>False</Private>
</Reference>
<Reference Include="Elin">
<HintPath>C:\Program Files (x86)\Steam\steamapps\common\Elin\Elin_Data\Managed\Elin.dll</HintPath>
<Private>False</Private>
</Reference>
<Reference Include="Plugins.BaseCore">
<HintPath>C:\Program Files (x86)\Steam\steamapps\common\Elin\Elin_Data\Managed\Plugins.BaseCore.dll</HintPath>
<Private>False</Private>
</Reference>
<Reference Include="Plugins.UI">
<HintPath>C:\Program Files (x86)\Steam\steamapps\common\Elin\Elin_Data\Managed\Plugins.UI.dll</HintPath>
<Private>False</Private>
</Reference>
<Reference Include="UnityEngine">
<HintPath>C:\Program Files (x86)\Steam\steamapps\common\Elin\Elin_Data\Managed\UnityEngine.dll</HintPath>
<Private>False</Private>
</Reference>
<Reference Include="UnityEngine.CoreModule">
<HintPath>C:\Program Files (x86)\Steam\steamapps\common\Elin\Elin_Data\Managed\UnityEngine.CoreModule.dll</HintPath>
<Private>False</Private>
</Reference>
<Reference Include="UnityEngine.UI">
<HintPath>C:\Program Files (x86)\Steam\steamapps\common\Elin\Elin_Data\Managed\UnityEngine.UI.dll</HintPath>
<Private>False</Private>
</Reference>
</ItemGroup>
<HintPath> 에서 "C:\Program Files (x86)\Steam\steamapps\common\Elin" 부분을 본인이 엘린을 설치한 위치로 바꾼 뒤 저장한다.
정상적으로 로딩이 됐다면, 우측 메뉴의 "종속성 - 어셈블리" 에 들어가보면 라이브러리들이 나올 것이다.
만일 느낌표가 떠있다면 로딩이 안 되었다는 뜻이니 다시 시도해보자.
8. 코드 작성.
그 뒤 메인 파일을 편집하자.
이것은 BepInEx 공식 문서에 등장하는 플러그인 기본 형태이다.
클래스명까지 맞출 필요는 없고, BaseUnityPlugin을 상속하고 Awake(); 메소드를 만들어주자.
그 뒤 클래스 위에 대괄호로 적혀있는 것은 아래와 같이 대체가 가능하다.
순서대로 plugin의 uid, 플러그인 이름, 플러그인 버전이다.
우리가 만든 플러그인이 어떤 것인지 우리가 설명해주는 것이다. 대충 적어보자
그럼 우리가 수정한 파일이 대충 이런 모습이 될 것이다.
이제 새로운 cs폴더를 하나 생성하고 하모니 코드를 작성해보자.
우리는 Chara의 ai가 AI_Meditate인 경우 CanSleep이 false를 반환하게 만들 것이다.
Patch 메소드를 정의해주면 결과적으로 위와 같은 모습이 된다.
여기서 우리가 주의해서 봐야하는 부분은 어트리뷰트([HarmonyPostfix], [HarmonyPatch])를 사용하는 부분이다.
우리는 위와 같은 어트리뷰트를 통해서 크게 2가지 정보를 하모니에게 전달한다.
하나는 어떤 메소드를 패치할 것인가? 하는 부분이다. => [HarmonyPatch]
=> 메소드는 일반적으로 클래스 내부에 있으니 클래스명도 같이 적어줘서 Chara의 CanSleep 메소드를 패치하라고 명시했다.
나머지 하나는 패치를 어떻게 할 것인가? 하는 부분이다. => [HarmonyPostfix]
=> 우리는 메소드의 return 값을 가로채기로 했으므로 postfix를 사용했다.
또 주의 사항이 있다. Harmony가 패치하기 위해 사용하는 메소드는 반드시 static 메소드여야 한다.
위와 같은 조건을 지키면 그 다음에는 메소드를 작성하는 것만 남는다. 이 작업은 어떻게 하느냐?
__instance나 __result 같은 매개 변수가 함수에 정의되어 있는 것이 보일 것이다.
메소드가 실행되는 인스턴스와 메소드에 접근하기 위해 선언한 것이다.
이게 Harmony로 코드를 작성할 때의 핵심이다. 이를 이용해 원본을 작업을 완전히 갈아치울 수도 있기 때문이다.
자세한 사항은 Harmony 공식 문서에서 Injections 란을 살펴보면 된다.
패치 메소드를 다 썼으니, 다시 돌아가서 Awake(); 메소드 안에 Harmony.CreateAndPatchAll(); 을 사용해준다.
이로서 이 플러그인이 로딩되면, CanSleep(); 뒤에 우리가 정의한 메소드가 실행될 것이다.
그럼 이제 빌드를 해서 dll파일을 가져오자.
별 설정이 없다면 dll 파일은 해당 프로젝트 폴더의 bin/Debug/netstandard2.0 폴더에 있을 것이다.
그 뒤 엘린 게임 폴더 내부의 Package라는 폴더에 들어가 Mod_DcMod라는 폴더를 만들고, 그 안에 dll 파일을 넣는다.
그 뒤에 메모장을 켠 뒤에 아래와 같은 xml 코드를 복붙한 뒤, 적절히 수정한다.
<?xml version="1.0" encoding="utf-8"?>
<Meta>
<title>Custom Map Test(Example Mod)</title>
<id>elin_example_mod_custom_map1</id>
<author>Lafrontier</author>
<loadPriority>100</loadPriority>
<description>This is a sample description text for this workshop item.
</description>
</Meta>
그 다음 같은 폴더에 package.xml이라는 파일명으로 저장한다.
그러면 결과적으로 이런 모습이 될 것이다.
9. 디버그
그럼 이제 디버깅을 해보자. 하지만 그 전에 한 가지 설정할 게 있다.
엘린 게임 폴더 안에 BepInEx/config/BepInEx.cfg 라는 파일이 있다.
이것을 텍스트 편집기로 연 다음에 아래로 내리다 보면 Logging.Console이라는 옵션이 있다.
이건 BepInEx의 콘솔창을 열 것인지 말지를 결정하는 옵션이다.
false로 되어 있는 기본값을 위와 같이 true로 바꿔준다.
이 콘솔을 통해서 우리가 Harmony 코드에 써놓은 Console.WriteLine(); 의 내용이 출력될 것이다.
그 뒤에 엘린을 켜서 Hook을 달아준다.
우리가 수정한 것이 제대로 적용되었다면, CanSleep(); 메소드는 졸림 상태에서 Chara.ai가 AI_Meditate여도 false를 반환할 것이다.
만일 캐릭터가 졸려하지 않는다면 2편에서 다루었던 대로 pc의 Chara 인스턴스에 들어가서 직접 값을 수정해주자.
그리고 명상을 눌러보면?
아까 우리가 설정을 고쳐서 띄운 BepInEx 콘솔 창을 확인해보자.
우리가 디버그용으로 출력한 문자열과 CanSleep();이 False를 반환한 것을 볼 수 있다.
+성공!
댓글 영역
획득법
① NFT 발행
작성한 게시물을 NFT로 발행하면 일주일 동안 사용할 수 있습니다. (최초 1회)
② NFT 구매
다른 이용자의 NFT를 구매하면 한 달 동안 사용할 수 있습니다. (구매 시마다 갱신)
사용법
디시콘에서지갑연결시 바로 사용 가능합니다.