시작하기-신규

플러그인 개발자를 위한 시작 가이드라인

1. 요구 사항

• 본 문서는 자바 플러그인 개발자를 위한 문서입니다. Skript 또는 Kotlin은 사용하지 않습니다.

• 운영체제는 윈도우 10~ 환경을 전제로 합니다.

2. 기본 정보 확인 및 권한 세팅

• 시그네트워크 개발서버 디스코드에서 #introduction 을 작성 해주세요.

• 시그네트워크 개발서버 디스코드에서 개발(JAVA) 역할을 받아주세요.

• 베어타운 디스코드에서 개발자 역할을 받아주세요.

• https://git.sigcraft.net:8443/ 에서 개발자 계정을 받아주세요.

• SigLib, SigDrop, SigItem 레포지토리의 접근 권한을 받아주세요.

• 내부 레포지토리(sigcraft-repo)의 비밀번호를 받아주세요.

• (권장) Gitbook 계정 비밀번호를 받아주세요.

3. 개발 환경 세팅

• IntelliJ IDEA를 설치 해주세요. (https://www.jetbrains.com/ko-kr/idea/download/)

• (권장) Minecraft Development 플러그인을 설치 해주세요. 링크

• (권장) IntelliJ IDEA의 사용 언어는 영어로 설정 해주세요.

• Help -> Check for updates...를 통해 IntelliJ를 업데이트 해주세요.

IntelliJ IDEA는 Community 버전이어도 개발에 큰 문제는 없으나, Ultimate 버전을 사용할 것을 권장합니다.

• MySQL(혹은 MariaDB)을 설치 해주세요. 설치 후 5. 빌드 시스템 세팅에서 사용할 데이터 베이스를 생성 해주세요. (CREATE DATABASE sigtest)

• Redis 환경을 세팅해주세요. Docker 환경을 권장합니다.

4. 프로젝트 생성 및 레포지토리 세팅

• https://git.sigcraft.net:8443/ 에서 생성하고 싶은 프로젝트를 Fork 합니다.

• IntelliJ에서 Get From VCS를 선택 한 후, 포크된 레포지토리의 GitLab 화면에서 Code -> Clone with HTTPS...에 있는 링크를 복사합니다.

• VCS -> Manage Remotes... 에서 원본 beartown 레포지토리를 upstream이라는 이름으로 추가합니다. 링크는 위와 동일한 방법으로 가져올 수 있습니다. (예: name: upstream, url: https://git.sigcraft.net:8443/beartown/SigLib.git)

• Git Fetch를 실행해 깃 로그가 올바르게 로드 되는지 확인합니다.

만약 upstream 링크로 프로젝트를 생성해 Push 시 beartown의 원본 레포지토리로 바로 올라가는 상태가 된 경우, 아래 명령으로 upstream branch를 변경할 수 있습니다.

git branch master -u origin/master

5. 빌드 시스템 세팅

Maven

• 일부 프로젝트는 빌드 시스템으로 Maven을 사용하고 있습니다. Gradle 프로젝트에 대해서는 하위 문단을 참고해주세요.

• C:\Users\사용자명\.m2에 위치한 settings.xml에 다음 내용을 추가 해주세요.

  <servers>
    <server>
      <id>sigcraft-repo</id>
      <username>repo_public</username>
      <password>provided</password> <!-- 제공받은 비밀번호 입력 -->
    </server>
  </servers>
  
  <profiles>
    <profile>
      <id>minecraft</id>
      <properties>
        <application-home>C:/Users/User/Downloads/Minecraft/Paper 1.20.4/plugins</application-home>
        <bungee-home>C:/Users/User/Downloads/Minecraft/BungeeCord 1.20/plugins</bungee-home>
      </properties>
    </profile>
  </profiles>
  
  <activeProfiles>
    <activeProfile>minecraft</activeProfile>
  </activeProfiles>
  
  <mirrors>
    <mirror>
      <id>sigcraft-repo</id>
      <name>sigcraft Repo Mirror</name>
      <url>https://repo.sigcraft.net:8443/repository/maven-releases/</url>
      <mirrorOf>sigcraft-repo</mirrorOf>
    </mirror>
  </mirrors>

application-home과 bungee-home은 로컬 서버의 plugins 폴더가 나오는 경로로 설정해주세요.

• 대부분의 레포지토리 에는 sigcraft-repo 설정이 되어 있으나, 필요한 경우 다음 구문으로 레포지토리를 pom.xml에 설정할 수 있습니다.

        <repository>
            <id>sigcraft-repo</id>
            <url>https://repo.sigcraft.net:8443/repository/maven-releases/</url>
        </repository>

위 레포지토리에 존재하는 파일은 아래의 링크에서 확인할 수 있습니다. (ID, 비밀번호는 pom.xml의 설정과 동일)

https://repo.sigcraft.net:8443/repository/maven-releases/repo.sigcraft.net

• Maven Reload를 실행해 주세요. (Maven 메뉴 -> Reload All Maven Projects)

Maven Reload가 올바르게 되지 않은 경우 Invalidate Caches, IntelliJ 폴더(.idea) 삭제나, Maven Unlink Project 후 재추가 등의 방법을 사용할 수 있습니다.

• Run -> Edit Configurations... -> +버튼 -> Maven를 통해 빌드 설정을 추가해주세요. 이때 Run에 들어가는 빌드 설정은 clean package를 사용합니다.

• 레포지토리에 올라가 있는 라이브러리의 경우 다음과 같은 방법을 통해 추가할 수 있습니다.

        <dependency>
            <groupId>io.lumine.mythic</groupId>
            <artifactId>MythicLib</artifactId>
            <version>1.5</version>
        </dependency>
        
        <dependency>
            <groupId>com.signition</groupId>
            <artifactId>SigLib</artifactId>
            <version>1.1.0</version> # 최신버전은 다를 수 있음
        </dependency>

Gradle

• Gradle을 사용하는 프로젝트에 대해서는 Maven와 약간 다른 설정이 요구됩니다.

• C:\Users\사용자명\.gradle에 위치한 gradle.properties에 다음 내용을 추가 해주세요.

nexus_username=repo_public
nexus_password=provided # 제공받은 비밀번호 입력
build_directory=C:/server_path/Paper 1.20.4/plugins
bungee_directory=C:/bungee_path/Paper 1.20.4/plugins # SigBungeeCore 전용
server_jar=C:/server_path/Paper 1.20.4/paper-1.20.4-497.jar # 비필수

• Gradle Sync를 실행해 주세요. (Gradle 메뉴 -> Sync All Gradle Projects)

• Run -> Edit Configurations... -> +버튼 -> Gradle을 통해 빌드 설정을 추가해주세요. 이때 Run에 들어가는 빌드 설정은 build를 사용합니다. (경우에 따라 clean build 를 사용할 수도 있습니다.)

• 레포지토리에 올라가 있는 라이브러리의 경우 다음과 같은 방법을 통해 추가할 수 있습니다.

dependencies {    
    implementation("org.slf4j:slf4j-api:2.0.9")
    implementation("org.jetbrains:annotations:24.1.0")
}

6. 테스트 설정

• src/test/resources/database.yml을 추가해야 합니다.

• 이를 쓰는 시점에서는 SigLib만 필요로 하나 추후 수정될 수 있으며, 만약 작동하지 않는 테스트가 있다면 추가 해보는 것을 권장합니다.

MYSQL:
  hostname: "localhost"
  port: 3306
  database: "sigtest"
  username: "root"
  password: "1234"
  minimumConnections: 2
  maximumConnections: 10
  connectionTimeout: 3000
  tablePrefix: "siglib"

REDIS:
  hostname: "localhost"
  port: 6379
  database: 0
  keyPrefix: "siglib"

이제 플러그인 빌드를 실행할 수 있습니다. SigLib를 빌드 해서 플러그인 폴더에 정상적으로 생성되는지 확인 해보세요.

7. 서버 세팅

• 필요한 플러그인을 https://repo.sigcraft.net:8443/repository/maven-releases/ 에서 받아주세요. (일반적인 목록은 해당 플러그인의 plugins.yml -> depend: 에서 확인할 수 있습니다.)

• 실행기 예시:

@echo off
title Paper 1.20.4
:start
java -Xms1G -Xmx1G -Dfile.encoding=UTF-8 -jar paper-1.20.4-497.jar nogui
set /p yn=다시 시작 하시겠습니까? [y/n] : 
if /i "%yn%"=="n" exit
goto start

번지코드 설정

• 번지코드 설정이 필요한 경우, SigBungeeCore를 번지코드 플러그인 폴더에 넣어주세요.

• 이외 설정은 https://www.spigotmc.org/wiki/bungeecord-installation/ 를 참고해주세요.

8. 추가 사항 및 더 보기

• Spigot 자료 - Spigot 개발에 대한 자료를 포함합니다.

• IntellIJ 플러그인 - 추천하는 IntelliJ IDEA의 플러그인 목록입니다.

• Deploy Artifact - 서버 레포지토리에 자료를 배포하는 방법입니다.

• Convention - 서버에서 사용 중인 여러 표준입니다.

• Plugins - 내부 플러그인 Docs 입니다.