Lexiconfig Mod cho Minecraft 1.20.1, 1.21.1

Tổng quan

Đây là một API cấu hình nhằm cung cấp khả năng tương thích với nhiều thư viện cấu hình khác nhau cũng như dễ sử dụng trong thiết lập dự án đa loader, chủ yếu để dùng trong các mod của tôi.

Nó có cú pháp dựa trên annotation dễ sử dụng, giúp việc tạo các tệp cấu hình mới trở nên dễ dàng nhất có thể.

Nếu bạn là người dùng mod, thông tin này có lẽ không hữu ích lắm với bạn. Tuy nhiên, nếu bạn là nhà phát triển mod và muốn sử dụng Lexiconfig trong dự án của riêng mình, hãy cuộn xuống phần Development.

Hiện tại nó chưa hỗ trợ các thư viện cấu hình khác, nhưng khi tôi tiếp tục cập nhật, tôi sẽ thêm nhiều khả năng tương thích cho từng thư viện để đảm bảo nó không xung đột với các thư viện khác mà thay vào đó có thể tích hợp liền mạch giữa chúng.

Dưới đây là danh sách các tích hợp hiện có cũng như đang dự kiến across các thư viện/API cấu hình khác nhau:

❌ - Chưa tích hợp ✅ - Đã tích hợp ❓ - Đang thực hiện

Trạng thái Mod

❌ Cloth Config

❌ oωo config

✅ Configured

❌ Forge Config Screens

Development

Mod này chứa một api có thể được sử dụng để shelve các lexicon mới, lắng nghe sự kiện, v.v.

Depending

build.gradle

dependencies { implementation "com.codinglitch.lexiconfig:lexiconfig-api:APIVERSIONHERE" }

Bạn có thể truy cập https://versions.codinglitch.com để xem phiên bản api mới nhất.

Cách sử dụng

Để shelve các lexicon của riêng bạn, trước tiên bạn phải có Library của riêng mình. Điều này có thể được thực hiện bằng cách đơn giản tạo một lớp mới kế thừa lớp Library, và gắn annotation LexiconLibrary cho nó.

@LexiconLibrary public class MyNewLibrary extends Library { @Override public void shelveLexicons() { } }

Trong thiết lập Forge, không cần thay đổi gì thêm. Tuy nhiên, nếu bạn đang phát triển cho Fabric, bạn sẽ phải thêm lớp này làm entrypoint trong fabric.mod.json của mình.

fabric.mod.json

//... "entrypoints": { "lexiconfig": [ "com.path.to.MyNewLibrary" ] } //...

Bước tiếp theo là cuối cùng tạo và shelve các lexicon của bạn. Bạn có thể làm điều này bằng cách đơn giản tạo một lớp khác cho lexicon, và cung cấp cho nó các annotation phù hợp, như sau:

@Lexicon(name = MYLEXICONTITLE) // preferably use your mod id as a name public class MyLexicon extends LexiconData { @LexiconEntry(comment = "This is a comment for a simple field!") public String mySimpleField = "content"; @LexiconPage(comment = "This is a fancy new comment on the fancy new category!") public MyNewPage myNewPage = new MyNewPage(); public static class MyNewPage extends LexiconPageData { @LexiconEntry(comment = "This field is inside a lexicon page!") public Boolean myPageField = true; } }

Bước tiếp theo và cũng là bước cuối cùng là shelve lexicon, có thể được thực hiện bằng cách đơn giản thêm một instance của nó làm trường trong library và shelve nó trong phương thức đã cho.

@LexiconLibrary public class MyNewLibrary extends Library { public static MyLexicon MYLEXICON = new MyLexicon(); @Override public void shelveLexicons() { LexiconfigApi.shelveLexicon(MYLEXICON); } }