README_kr.md

TRGithub

마인크래프트 플러그인 TriggerReactor의 패키지 관리 툴

🚨주의🚨

이것은 프로토타입 버전이며 다소 불안정할 수 있습니다.

⚠️알려진 이슈⚠️

• 버킷의 인수부분에 --add-opens java.base/java.util.zip=ALL-UNNAME 를 추가해야 정상 작동합니다.
  해당 이슈는 일시적인것이므로, 다음 업데이트에는 필요 없어질 예정입니다.
  
  

how to use?

패키지 사용법에 대해서 서술합니다.

명령어

/github

명령어의 종류와 기능에 대해 설명 합니다.

/github active <packageName>
→ 패키지를 활성화, 또는 비활성화 합니다.

/github active <packageName> <overwrite | skip>
→ 중복된 파일을 어떻게 처리할지 미리 설정합니다.

※ /github active <packageName> 를 사용해도, 중복된 파일이 있다면, 선택지가 표시됩니다.
※ 비활성화 될때 패키지에 등록된 파일명의 파일은 모두 없어집니다.

/github package <packageName | *>
→ 패키지의 상세 정보를 확인합니다.

※ * 를 입력하면 모든 패키지의 상태가 나옵니다.

/github install <github repository url>
→ Url 의 Github Reposyitory에서 가장 최신인 태그 소스를 다운합니다.

/github install <github repository url> <version>
→ 위의 방법으로 버전을 선택 할 수도 있습니다.

/github install <packageName>
/github install <packageName> <version>
→ 위 방법으로 패키지를 업데이트 할 수 있습니다.

※ 패키지 활성화 상태 기본값 : Disable

/github delete <packageName>
→ 패키지를 영구적으로 삭제합니다.

※ 패키지에 등록된 파일명의 파일은 모두 없어집니다.

/github export
→ 패키지를 자동으로 만들어줍니다.(현재 구현 안됨.)

TRGithub로 패키지 구성하는 방법.

반갑습니다! TRGithub로 패키지를 만들고 싶으시군요?!

TRGithub로 패키지를 만드는 가이드를 해드리겠습니다.

패키지 구성

패키지의 구성은 다음과 같습니다.

package-info.json 파일과, 여러분이 만든 TriggerReactor 파일만 있으면 됩니다!

package-info.json의 구성은 다음과 같습니다.

  {
    "info": {
      "name": "패키지명",
      "author" : "제작자",
      "description": "패키지 설명",
      "jdk" : "권장 자바버전",
      "mc_version" : "테스트된 마인크래프트 버전",
      "trg_version" : "테스트된 트리거 버전"
    },
    "triggers": {
      "CommandTrigger": [
        "트리거파일.trg",
        "트리거파일.json"
      ]
    }
  }
      

위 코드는, 당신의 Repository 안의 CommandTrigger 디렉토리 안에 있는 트리거파일.trg 와 트리거파일.json 을 감지하고,
./plugin/TriggerReactor/CommandTrigger에 추가 하는 역할 을 해 줄 것입니다.

현재 TRGithub에서 지원하는 트리거는 다음과 같습니다.
"CommandTrigger", "CustomTrigger", "Executor", "InventoryTrigger", "NamedTriggers", "Placeholder", "RepeatTrigger", "Other"

"Other"는 추가적으로 필요한 파일이 있을때, ./plugin/TriggerReactor/Other 디렉토리에 추가해 줄 것입니다.
그러니 그게 맞게 코드를 짜는것도 중요하다고 할 수 있습니다.

릴리즈 생성

모든 파일을 깃허브에 업로드 하였다면. 이제 릴리즈를 만들 차례입니다.

릴리즈탭에 들어간 다음 Draft new Release 를 클릭하고, 태그를 생성한 다음, (태그명이 패키지 버전이 됩니다.)
타이틀도 적어주고, Publish Release를 클릭합니다.

아직도 이해가 안된다면
여기 완벽한 예제가 있습니다!

Example Package

./github install github.com/Cupelt/TRG_linearRegression 으로 다운로드 할 수 있으며,
./github active TRG_linearRegression 으로 패키지를 활성화 시킨 다음
./linear_regression 으로 패키지를 사용할 수 있습니다.

사용 예제

https://github.com/Cupelt/TRG_linearRegression 를 다운 받아서 사용 해 보겠습니다.

1. ./github install github.com/Cupelt/TRG_linearRegression 으로 다운로드 합니다.
   
2. ./github active TRG_linearRegression 으로 패키지를 활성화 시킨 다음.
   
3. ./linear_regression 으로 패키지를 사용할 수 있습니다.
   
   
4. 이제 패키지가 필요 없다면 ./github delete TRG_linearRegression 으로 패키지를 삭제 할 수 있습니다.
   
   
5. 해당 레포지토리에 새로운 릴리즈가 생긴다면 ./github install TRG_linearRegression 으로 패키지를 업데이트 할 수 있습니다.