เทมเพลตปลั๊กอินหัวจุก

เทมเพลตปลั๊กอิน Spigot

คุณสามารถใช้เทมเพลตนี้เพื่อพัฒนาปลั๊กอิน Spigot คุณภาพสูงของคุณเองโดยใช้ Gradle ได้อย่างง่ายดาย

ดูเทมเพลตเซิร์ฟเวอร์ minecraft เพื่อเริ่มต้นเครือข่าย Minecraft ของคุณอย่างรวดเร็วภายในเวลาไม่ถึง 30 วินาที

• คุณสมบัติ
• การตั้งค่าการเริ่มต้นอย่างรวดเร็ว
• การเปิดตัวปลั๊กอินเวอร์ชันใหม่ของคุณ
  • ยืนยันรูปแบบข้อความ
• การเผยแพร่แพ็คเกจ Maven ของคุณ
  • เกี่ยวกับกลุ่มและ artifactId
  • การรับรองความถูกต้องแพ็คเกจ Github
• การดีบักปลั๊กอินของคุณ
  • คัดลอกปลั๊กอินของคุณโดยอัตโนมัติ
  • การรันและการดีบักเซิร์ฟเวอร์ Minecraft
• อ้างอิง

คุณสมบัติ

เทมเพลตหรือต้นแบบที่ดีกว่านั้นมาพร้อมกับคุณสมบัติมากมายที่มีประโยชน์หากคุณต้องการพัฒนาปลั๊กอินคุณภาพสูง อย่างไรก็ตามคุณไม่จำเป็นต้องใช้ทั้งหมด คุณก็สามารถลบคุณสมบัติที่คุณไม่ต้องการออกได้

• พร้อมใช้โปรเจ็กต์ Gradle พร้อมงานยูทิลิตี้มากมาย
• การสร้าง plugin.yaml อัตโนมัติตามคุณสมบัติของโปรเจ็กต์ด้วย SpiGradle
• เซิร์ฟเวอร์ทดสอบ Spigot ในตัวด้วยการสร้างในคลิกเดียว คัดลอกปลั๊กอิน และเริ่มการดีบักในงาน IntelliJ
• ปลั๊กอิน Gradle shadow เพื่อจัดส่งการอ้างอิงที่คุณต้องการด้วยปลั๊กอินของคุณได้อย่างง่ายดาย
• ตัวอย่างการบูรณาการรวมถึงการทดสอบสำหรับ Annotation Command Framework และ Vault
• การตั้งค่าการทดสอบ JUnit 5 รวมถึง MockBukkit และ AssertJ
• รายงาน การครอบคลุมโค้ดของ Jacoco รวมถึงงานอัพโหลดไปยัง codecov
• ไปป์ไลน์การปล่อย ความหมายแบบผสาน รวมอย่างสมบูรณ์
• การสร้างบันทึกการเปลี่ยนแปลง อัตโนมัติตามข้อความคอมมิตทั่วไป
• เวิร์กโฟลว์ Github Actions สำหรับการสร้างและเผยแพร่
• การเผยแพร่ สิ่งประดิษฐ์ Maven ไปยังแพ็คเกจ GitHub

  ไม่จำเป็นต้องโฮสต์ Nexus หรือเซิร์ฟเวอร์ประดิษฐ์อีกต่อไป

• เทมเพลตปัญหา GitHub สำหรับข้อบกพร่องและคำขอคุณสมบัติ
• แนวทาง การมีส่วนร่วมและจรรยาบรรณ
• ป้าย สวยๆ สำหรับแสดงโครงการของคุณ

การตั้งค่าการเริ่มต้นอย่างรวดเร็ว

• สร้างโครงการ Github ใหม่โดยใช้เทมเพลตนี้
• โคลน พื้นที่เก็บข้อมูลใหม่และเปิดใน IntelliJ
• อัพเดต ไฟล์ gradle.properties และเปลี่ยนตัวแปรต่อไปนี้:
  • group : your-maven-group-id (เช่น: io.github.silthus)
  • pluginName : YourPluginName
  • author : YourName
• อัปเดต root.projectName ภายใน settings.gradle นี่จะเป็น artifactId ของคุณ
• ลบ CHANGELOG.md มันจะถูกสร้างขึ้นในการเปิดตัวครั้งแรกของคุณ
• อัปเดต README ให้ชี้ไปที่โครงการและรหัสทรัพยากรหัวจุกของคุณ
• เปลี่ยนชื่อ แพ็คเกจ Java และปลั๊กอินเพื่อให้ตรงกับโปรเจ็กต์ของคุณ
• จากนั้นดำเนินการงาน gradle prepareSpigotPlugins ซึ่งจะพยายามดาวน์โหลด denpendencies ของปลั๊กอินทั้งหมดและนำไปไว้ใน debug/spigot/plugins/
• เริ่ม เซิร์ฟเวอร์ Minecraft โดยดำเนินการงาน debugPaper นี่จะเริ่มต้นเซิร์ฟเวอร์ในเบื้องหลังและคุณสามารถเชื่อมต่อได้โดยใช้ที่อยู่ localhost:25565
• โค้ดออกไป :) - และเมื่อคุณพร้อมแล้ว ให้ผลักดันการคอมมิตของคุณ (ในรูปแบบการคอมมิตแบบเดิมๆ) ให้เป็นผู้เชี่ยวชาญ

โปรดอ่านหลักเกณฑ์การมีส่วนร่วมก่อนที่จะส่งคำขอดึงข้อมูลหรือปัญหาในการเปิด

บันทึก
คุณอาจต้องรันงาน gradle clean หลังจากเปลี่ยนชื่อแพ็คเกจและนำเข้าโปรเจ็กต์ gradle อีกครั้งเพื่อแก้ไขข้อผิดพลาดในการสร้างไฟล์ plugin.yml

การเปิดตัวปลั๊กอินเวอร์ชันใหม่ของคุณ

ข้อดีหลักประการหนึ่งของเทมเพลตนี้คือความจริงที่ว่าจะ เผยแพร่เวอร์ชันใหม่โดยอัตโนมัติ ทุกครั้งที่ Push to master ตามข้อความที่คุณคอมมิต เพื่อให้แน่ใจว่าปลั๊กอินของคุณได้รับการเผยแพร่ตามแนวทางการกำหนดเวอร์ชันเชิงความหมาย เพื่อให้ได้ผล คุณต้องปฏิบัติตามกฎง่ายๆ สองสามข้อ:

• คอมมิตเฉพาะโค้ดที่ใช้งานได้และทดสอบแล้วกับสาขาหลัก ใช้คำขอดึงเพื่อทำงานกับฟีเจอร์ที่ใหญ่ขึ้นหรือแก้ไขข้อบกพร่อง แล้วรวมเข้าด้วยกันเมื่อคุณพร้อม
• การแก้ไขข้อบกพร่อง คุณลักษณะ และการเปลี่ยนแปลงทั้งหมดควรมีการคอมมิตหนึ่งรายการที่เกี่ยวข้องกัน อย่ารวมข้อบกพร่อง คุณสมบัติ ฯลฯ หลายรายการไว้ในข้อความคอมมิตขนาดใหญ่ข้อความเดียว รักษาขนาดการคอมมิตให้เล็กและคอมมิตบ่อยๆ
• ข้อความคอมมิตของคุณต้องเป็นไปตามกฎคอมมิตทั่วไป

ยืนยันรูปแบบข้อความ

ดูหน้าแรกของ Commit แบบทั่วไปสำหรับรายละเอียดและตัวอย่างเพิ่มเติมในหัวข้อ แต่นี่เป็นข้อมูลสรุปสั้นๆ เพื่อให้คุณเริ่มต้นได้

ข้อกำหนด Conventional Commits เป็นแบบแผนน้ำหนักเบาที่อยู่ด้านบนของข้อความการคอมมิต มีชุดกฎง่ายๆ สำหรับการสร้างประวัติการคอมมิตที่ชัดเจน ซึ่งทำให้ง่ายต่อการเขียนเครื่องมืออัตโนมัติทับลงไป แบบแผนนี้สอดคล้องกับ SemVer โดยการอธิบายคุณสมบัติ การแก้ไข และการทำลายการเปลี่ยนแปลงที่ทำในข้อความคอมมิต

ข้อความยืนยันควรมีโครงสร้างดังนี้:

 [optional scope]: 

[optional body]

[optional footer(s)]

คอมมิตประกอบด้วยองค์ประกอบโครงสร้างต่อไปนี้ เพื่อสื่อสารเจตนาไปยังผู้บริโภคไลบรารีหรือปลั๊กอินของคุณ:

• fix: การคอมมิตประเภทการแก้ไขจะแก้ไขข้อบกพร่องในโค้ดเบสของคุณ (สิ่งนี้สัมพันธ์กับ PATCH ในการกำหนดเวอร์ชันเชิงความหมาย)
• feat: การคอมมิตประเภท feat แนะนำคุณสมบัติใหม่ให้กับ codebase (สิ่งนี้สัมพันธ์กับ MINOR ในการกำหนดเวอร์ชันเชิงความหมาย)
• BREAKING CHANGE: คอมมิตที่มีส่วนท้าย BREAKING CHANGE: หรือต่อท้าย ! หลังจากประเภท/ขอบเขต จะแนะนำการเปลี่ยนแปลง API ที่ไม่สมบูรณ์ (สัมพันธ์กับ MAJOR ในการกำหนดเวอร์ชันเชิงความหมาย) การเปลี่ยนแปลงที่ทำลายล้างสามารถเป็นส่วนหนึ่งของการคอมมิตประเภทใดก็ได้
• ประเภทอื่นที่ไม่ใช่ fix: และ feat: ได้รับอนุญาต เช่น @commitlint/config-conventional (ขึ้นอยู่กับแบบแผนเชิงมุม) แนะนำ build: , chore: , ci: , docs: , style: , refactor: , perf: , test: และอื่นๆ
• ส่วนท้ายอื่นนอกเหนือจาก BREAKING CHANGE: และปฏิบัติตามรูปแบบที่คล้ายกับรูปแบบตัวอย่าง git ประเภทเพิ่มเติมไม่ได้รับคำสั่งจากข้อกำหนด Conventional Commits และไม่มีผลกระทบโดยนัยในการกำหนดเวอร์ชันเชิงความหมาย (เว้นแต่จะรวมการเปลี่ยนแปลงที่แตกหัก)

อาจมีการกำหนดขอบเขตให้กับประเภทของการคอมมิต เพื่อให้ข้อมูลตามบริบทเพิ่มเติม และอยู่ภายในวงเล็บ เช่น 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 ของคุณ

ปลั๊กอินของคุณจะถูกเผยแพร่โดยอัตโนมัติเป็นแพ็คเกจ maven บนแพ็คเกจ Github ทันทีที่คุณออกเวอร์ชันใหม่

เกี่ยวกับกลุ่มและ artifactId

group ที่ต่อท้ายโดย artifactId ของคุณจะถูกใช้เพื่อระบุโปรเจ็กต์ของคุณโดยไม่ซ้ำกันเมื่อนำเข้าในโปรเจ็กต์อื่น เมื่อคุณนำเข้าหัวจุกในโปรเจ็กต์ของคุณ คุณจะใช้กลุ่ม org.spigotmc ตามด้วย artifactId spigot-api และเวอร์ชัน

ข้อมูลต่อไปนี้นำมาจากคู่มือการตั้งชื่อ Maven อย่างเป็นทางการ

• groupId ระบุโปรเจ็กต์ของคุณโดยไม่ซ้ำกันในทุกโปรเจ็กต์ ID กลุ่มควรเป็นไปตามกฎชื่อแพ็คเกจของ Java ซึ่งหมายความว่าจะเริ่มต้นด้วยชื่อโดเมนที่กลับรายการที่คุณควบคุม ตัวอย่างเช่น: org.apache.maven , org.apache.commons
  หากคุณไม่ได้เป็นเจ้าของโดเมน คุณสามารถใช้โดเมน github io.github ต่อท้ายด้วยชื่อผู้ใช้ Github ของคุณ เช่น io.github.silthus
• artifactId คือชื่อของ jar ที่ไม่มีเวอร์ชัน หากคุณสร้างมันขึ้นมา คุณสามารถเลือกชื่ออะไรก็ได้ที่คุณต้องการด้วยตัวอักษรพิมพ์เล็กและไม่มีสัญลักษณ์แปลกๆ ตัวอย่างเช่น: `maven, commons-math

การรับรองความถูกต้องแพ็คเกจ Github

คุณต้องกำหนดค่าการตรวจสอบสิทธิ์สำหรับแพ็คเกจ Github หากคุณต้องการใช้แพ็คเกจ Maven ในโปรเจ็กต์อื่น

1. สร้างโทเค็นการเข้าถึงส่วนบุคคล Github
2. สร้างหรืออัปเดต gradle.properties ภายใน C:Users%username%.gradle ด้วยสิ่งต่อไปนี้ และแทนที่ YOUR_GITHUB_USERNAME ด้วยชื่อผู้ใช้ Github ของคุณและ YOUR_PERSONAL_ACCESS_TOKEN ด้วยโทเค็นการเข้าถึงจากขั้นตอนที่ 1

 gpr.user =YOUR_GITHUB_USERNAME
gpr.key =YOUR_PERSONAL_ACCESS_TOKEN

การดีบักปลั๊กอินของคุณ

คัดลอกปลั๊กอินของคุณโดยอัตโนมัติ

คุณสามารถส่งออกปลั๊กอินของคุณไปยังไดเร็กทอรีปลั๊กอินจากไดเร็กทอรีการทำงานของคุณด้วยงาน Gradle allowanceSpigotPlugins งานจะ สร้างและคัดลอก ปลั๊กอินของคุณไปยังไดเร็กทอรี plugins/ โดยอัตโนมัติ

การรันและการดีบักเซิร์ฟเวอร์ Minecraft

คุณสามารถเรียกใช้หรือดีบักปลั๊กอินของคุณโดยใช้การกำหนดค่าการรัน Server จากภายใน IntelliJ เพื่อดาวน์โหลดเซิร์ฟเวอร์ Minecraft โดยอัตโนมัติ สร้างมันขึ้นมา คัดลอกปลั๊กอินของคุณและปลั๊กอินที่เกี่ยวข้องลงไป และเริ่มในโหมดแก้ไขจุดบกพร่อง

นี่เป็นเพราะพลังอันยอดเยี่ยมของงานแก้ไขข้อบกพร่องของ Spigradle ค้นหาข้อมูลเพิ่มเติมได้ที่หน้า Spigradle Github

อ้างอิง

• Spigradle: มอบงานไล่ระดับที่ยอดเยี่ยมที่ทำให้ชีวิตของคุณง่ายขึ้นมาก
• semantic-release: ในความคิดของฉันทุกโครงการควรใช้สิ่งนี้!
• ข้อความคอมมิตแบบธรรมดา: คอมมิตข้อความด้วยวิธีที่ถูกต้อง