스피곳 플러그인 템플릿

스피곳 플러그인 템플릿

이 템플릿을 사용하면 Gradle을 사용하여 자신만의 고품질 Spigot 플러그인을 쉽게 개발할 수 있습니다.

30초 이내에 Minecraft 네트워크를 빠르게 시작하려면 마인크래프트 서버 템플릿을 참조하세요.

• 특징
• 빠른 시작 설정
• 플러그인의 새 버전 출시
  • 커밋 메시지 형식
• Maven 패키지 게시
  • 그룹 및 이슈 ID 정보
  • Github 패키지 인증
• 플러그인 디버깅
  • 플러그인을 자동으로 복사하세요
  • Minecraft 서버 실행 및 디버깅
• 참고자료

특징

템플릿이나 더 나은 상용구에는 고품질 플러그인을 개발하려는 경우 유용한 많은 기능이 포함되어 있습니다. 그러나 모든 기능을 사용할 필요는 없으며 필요하지 않은 기능만 제거하면 됩니다.

• 많은 유틸리티 작업으로 Gradle 프로젝트를 사용할 준비가 되었습니다.
• SpiGradle을 사용하여 프로젝트 속성을 기반으로 plugin.yaml 자동 생성
• IntelliJ 작업에서 원클릭 빌드, 플러그인 복사 및 디버깅 시작 기능을 갖춘 통합 Spigot 테스트 서버
• 플러그인과 함께 필요한 종속성을 쉽게 제공하는 Gradle 섀도우 플러그인
• Annotation Command Framework 및 Vault에 대한 테스트를 포함한 통합 예시입니다.
• MockBukkit 및 AssertJ를 포함한 JUnit 5 테스트 설정
• codecov에 업로드 작업을 포함한 Jacoco 코드 적용 범위 보고서
• 완전히 통합된 의미론적 릴리스 릴리스 파이프라인
• 기존 커밋 메시지를 기반으로 자동 변경 로그 생성
• 빌드 및 릴리스를 위한 Github Actions 워크플로
• GitHub 패키지에 Maven 아티팩트 게시

  더 이상 자체 호스팅 넥서스나 아티팩트 서버가 필요하지 않습니다.

• 버그 및 기능 요청을 위한 GitHub 문제 템플릿
• 기여 및 행동강령 지침
• 귀하의 프로젝트를 보여주는 멋진 배지

빠른 시작 설정

• 이 템플릿을 사용하여 새 Github 프로젝트를 만듭니다.
• 새 저장소를 복제 하고 IntelliJ에서 엽니다.
• gradle.properties 파일을 업데이트하고 다음 변수를 변경합니다.
  • group : your-maven-group-id (예: io.github.silthus)
  • pluginName : 귀하의 플러그인 이름
  • author : YourName
• settings.gradle 내에서 root.projectName 을 업데이트합니다 . 이것이 귀하의 artifactId 될 것입니다.
• CHANGELOG.md 를 삭제합니다 . 첫 번째 릴리스에서 생성됩니다.
• 프로젝트 및 꼭지 리소스 ID를 가리키도록 README 를 업데이트하세요 .
• 프로젝트와 일치하도록 Java 패키지와 플러그인의 이름을 바꿉니다 .
• 그런 다음 prepareSpigotPlugins gradle 작업을 실행하면 모든 플러그인 종속성을 다운로드하여 debug/spigot/plugins/ 에 넣습니다.
• debugPaper 작업을 실행하여 Minecraft 서버를 시작합니다 . 그러면 백그라운드에서 서버가 시작되고 localhost:25565 주소를 사용하여 서버에 연결할 수 있습니다.
• 코드 작성 :) - 준비가 되면 커밋(기존 커밋 스타일)을 마스터하도록 푸시하세요.

끌어오기 요청을 제출하거나 이슈를 열기 전에 기여 지침을 읽어보세요.

메모
plugin.yml 생성 오류를 해결하려면 패키지 이름을 바꾼 후 gradle clean 작업을 실행하고 Gradle 프로젝트를 다시 가져와야 할 수도 있습니다.

플러그인의 새 버전 출시

이 템플릿의 주요 이점 중 하나는 커밋 메시지를 기반으로 master 에 푸시할 때마다 새 버전이 자동으로 릴리스 된다는 점입니다. 이렇게 하면 의미 체계 버전 관리 지침에 따라 플러그인이 릴리스됩니다. 이것이 작동하려면 몇 가지 간단한 규칙을 따라야 합니다.

• 작동하고 테스트된 코드만 마스터 브랜치에 커밋하세요. 풀 요청을 사용하여 더 큰 기능이나 버그 수정 작업을 수행하고 준비가 되면 병합하세요.
• 모든 버그 수정, 기능 및 변경 사항에는 하나의 커밋이 연결되어 있어야 합니다. 여러 버그, 기능 등을 하나의 거대한 커밋 메시지에 혼합하지 마세요. 커밋 크기를 작게 유지하고 자주 커밋하세요.
• 커밋 메시지는 기존 커밋 규칙을 따라야 합니다.

커밋 메시지 형식

해당 주제에 대한 자세한 내용과 예제는 기존 커밋 홈페이지를 참조하세요. 하지만 시작하는 데 도움이 되는 간단한 요약은 다음과 같습니다.

Conventional Commits 사양은 커밋 메시지에 추가되는 간단한 규칙입니다. 명시적인 커밋 기록을 생성하기 위한 쉬운 규칙 세트를 제공합니다. 이를 통해 자동화된 도구를 더 쉽게 작성할 수 있습니다. 이 규칙은 커밋 메시지의 기능, 수정 사항 및 주요 변경 사항을 설명함으로써 SemVer와 딱 들어맞습니다.

커밋 메시지는 다음과 같이 구성되어야 합니다.

 [optional scope]: 

[optional body]

[optional footer(s)]

커밋에는 라이브러리 또는 플러그인 소비자에게 의도를 전달하기 위해 다음과 같은 구조적 요소가 포함되어 있습니다.

• fix: 유형의 커밋은 코드베이스의 버그를 패치합니다(이는 의미론적 버전 관리의 PATCH와 관련이 있습니다).
• feat: feat 유형의 커밋은 코드베이스에 새로운 기능을 도입합니다(이것은 의미적 버전 관리에서 MINOR와 관련이 있습니다).
• BREAKING CHANGE: 바닥글이 있는 커밋입니다. 주요 변경 사항: 또는 ! 유형/범위 뒤에는 획기적인 API 변경이 도입됩니다(의미론적 버전 관리에서 MAJOR와 연관됨). 주요 변경 사항은 모든 유형의 커밋에 포함될 수 있습니다.
• fix: 및 feat: 이외의 유형이 허용됩니다. 예를 들어 @commitlint/config-conventional(Angular 규칙 기반)에서는 build: , chore: , ci: , docs: , style: , refactor: , perf: , test: 권장합니다. test: 및 기타.
• BREAKING CHANGE: 이 제공될 수 있으며 git Trailer 형식과 유사한 규칙을 따를 수 있습니다. 추가 유형은 기존 커밋 사양에서 요구되지 않으며 의미 체계 버전 관리에 암시적인 영향을 미치지 않습니다(주요 변경 사항을 포함하지 않는 한).

범위는 추가 상황 정보를 제공하기 위해 커밋 유형에 제공될 수 있으며 괄호 안에 포함됩니다(예: feat(parser): add ability to parse arrays .

다음은 몇 가지 예입니다.

설명 및 주요 변경 사항 바닥글이 포함된 커밋 메시지

 feat: allow provided config object to extend other configs

BREAKING CHANGE: `extends` key in config file is now used for extending other config files

본문 없이 메시지 커밋

 docs: correct spelling of CHANGELOG

범위가 있는 메시지 커밋

 feat(lang): add polish language

여러 단락으로 구성된 본문과 여러 바닥글이 포함된 커밋 메시지

 fix: correct minor typos in code

see the issue for details

on typos fixed.

Reviewed-by: Z
Refs #133

Maven 패키지 게시

새 버전이 출시되는 즉시 플러그인이 Github 패키지에 Maven 패키지로 자동 게시됩니다.

그룹 및 이슈 ID 정보

artifactId 로 추가된 group 프로젝트를 다른 프로젝트로 가져올 때 프로젝트를 고유하게 식별하는 데 사용됩니다. 프로젝트에서 스피곳을 가져올 때 org.spigotmc 그룹 뒤에 아티팩트 ID spigot-api 와 버전을 사용합니다.

다음은 공식 Maven 명명 가이드에서 가져온 것입니다.

• groupId 모든 프로젝트에서 프로젝트를 고유하게 식별합니다. 그룹 ID는 Java의 패키지 이름 규칙을 따라야 합니다. 이는 귀하가 제어하는 ​​역방향 도메인 이름으로 시작한다는 의미입니다. 예: org.apache.maven , org.apache.commons .
  도메인을 소유하지 않은 경우 Github 사용자 이름이 추가된 github 도메인 io.github 사용할 수 있습니다(예: io.github.silthus .
• artifactId 버전이 없는 jar의 이름입니다. 이름을 만들었다면 소문자로, 이상한 기호 없이 원하는 이름을 선택할 수 있습니다. 예: `maven, commons-math

Github 패키지 인증

다른 프로젝트에서 Maven 패키지를 사용하려면 Github 패키지에 대한 인증을 구성해야 합니다.

1. Github 개인 액세스 토큰 생성
2. C:Users%username%.gradle 내에서 gradle.properties 생성하거나 업데이트하고 YOUR_GITHUB_USERNAME Github 사용자 이름으로 바꾸고 YOUR_PERSONAL_ACCESS_TOKEN 을 1단계의 액세스 토큰으로 바꿉니다.

 gpr.user =YOUR_GITHUB_USERNAME
gpr.key =YOUR_PERSONAL_ACCESS_TOKEN

플러그인 디버깅

플러그인을 자동으로 복사하세요

Gradle prepareSpigotPlugins 작업을 사용하여 작업 디렉터리에서 플러그인 디렉터리로 플러그인을 내보낼 수 있습니다. 작업은 플러그인을 자동으로 빌드하고 plugins/ 디렉터리에 복사합니다 .

Minecraft 서버 실행 및 디버깅

IntelliJ 내에서 Server 실행 구성을 사용하여 플러그인을 실행하거나 디버깅하여 Minecraft 서버를 자동으로 다운로드하고 구축한 후 종속 플러그인을 복사하고 디버깅 모드에서 시작할 수 있습니다.

이는 Spigradle 디버그 작업의 놀라운 성능 때문입니다. Spigradle Github 페이지에서 자세한 내용을 알아보세요.

참고자료

• Spigradle: 삶을 훨씬 쉽게 만들어주는 멋진 Gradle 작업을 제공합니다.
• semantic-release: 제 생각에는 모든 프로젝트에서 이것을 사용해야 한다고 생각합니다!
• 기존 커밋 메시지: 메시지를 올바른 방식으로 커밋하세요.