GitHub 오픈소스 탐험

슬레이 더 스파이어(Slay the Spire) 시리즈는 카드 덱 빌딩 게임의 대명사로 자리 잡았습니다. 특히 후속작인 Slay the Spire 2는 이전의 성공을 이어받아 많은 유저와 개발자들에게 사랑받고 있습니다. 그러나 이 게임의 매력적인 콘텐츠를 더욱 풍부하게 만들기 위해서는 모드(Mod) 개발이 필수적입니다. 그런데 모드 개발이 처음이라면 어떤 것부터 시작해야 할지 막막할 수 있습니다. 이럴 때 유용한 오픈소스 프로젝트가 바로 BaseLib입니다.

BaseLib란 무엇인가?

BaseLib는 Slay the Spire 2를 위한 모드로, 다른 모드들이 의존성으로 사용할 수 있는 기본 라이브러리 역할을 합니다. 이 프로젝트는 모드 개발자들이 보다 간편하게 콘텐츠를 추가하고 조정할 수 있도록 도와주며, 코드의 일관성을 유지할 수 있습니다. 이를 통해 복잡한 의존성 문제를 해결하고, 여러 모드를 동시에 사용할 때 발생할 수 있는 충돌을 방지할 수 있습니다.

주요 기능과 특징

표준화된 콘텐츠 추가: BaseLib는 다양한 모드들이 서로 호환되도록 도와줍니다. 이를 통해 개발자는 기존의 콘텐츠를 재사용할 수 있으며, 새로운 기능을 보다 쉽게 추가할 수 있습니다.
사용자 친화적인 문서화: 이 프로젝트는 문서화가 잘 되어 있어, 초보자도 쉽게 따라할 수 있는 가이드를 제공합니다. 특히 Wiki와 모드 시작 가이드가 유용합니다.
MIT 라이선스: 자유롭게 사용할 수 있는 MIT 라이선스를 채택하고 있어, 상업적인 프로젝트에서도 사용 가능합니다.

설치 및 기본 사용법

1단계: 라이브러리 다운로드

먼저 BaseLib를 사용하기 위해서는 라이브러리를 다운로드해야 합니다. GitHub의 릴리스 페이지에서 .dll, .pck, .json 파일을 다운로드합니다. 이 파일들은 Slay the Spire 2/mods 디렉토리에 넣어야 합니다.

2단계: 프로젝트 설정

다음으로, 자신의 모드 프로젝트에서 BaseLib를 의존성으로 추가해야 합니다. 아래와 같이 .csproj 파일에 다음 코드를 추가하세요.

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <OutputType>Library</OutputType>
    <TargetFramework>netstandard2.0</TargetFramework>
  </PropertyGroup>
  <ItemGroup>
    <PackageReference Include="Alchyr.Sts2.BaseLib" Version="*" />
  </ItemGroup>
</Project>

3단계: 코드 작성

이제 BaseLib를 활용하여 자신의 모드를 개발할 수 있습니다. 아래는 간단한 모드 예제 코드입니다.

using BaseLib;
using HarmonyLib;

public class MyMod : BaseMod
{
    public override void Initialize()
    {
        // 모드 초기화 코드
        Logger.Log("MyMod has been initialized!");
    }
    
    [HarmonyPatch(typeof(SpireGame), nameof(SpireGame.Start))]
    public class Patch
    {
        static void Postfix()
        {
            Logger.Log("SpireGame has started!");
        }
    }
}

위 코드는 모드가 초기화될 때와 게임이 시작될 때 로그를 출력하는 예제입니다. 이를 통해 BaseLib의 기본적인 사용법을 익힐 수 있습니다.

실무에서의 활용 시나리오

BaseLib를 활용하면 여러 모드를 동시에 사용할 수 있는 환경을 조성할 수 있습니다. 예를 들어, 특정 캐릭터의 능력을 추가하는 모드와 새로운 카드 템플릿을 추가하는 모드를 동시에 사용할 때, BaseLib를 통해 이 둘의 충돌을 피할 수 있습니다. 또한, 여러 개발자가 함께 작업할 때 코드의 일관성을 유지할 수 있어 팀워크를 향상시킬 수 있습니다.

비슷한 도구와의 비교

대부분의 모드 개발자는 BaseLib 외에도 다른 라이브러리를 고려하게 됩니다. 예를 들어, ModLib는 유사한 기능을 제공하지만, BaseLib는 더 많은 문서화와 커뮤니티 지원을 받는 점에서 유리합니다. 따라서 초보자에게는 BaseLib가 더 적합할 수 있습니다.

Slay the Spire 2 모드 개발의 기초, BaseLib로 시작해보자