Lexiconfig

Обзор

Это API конфигурации, предназначенный для обеспечения совместимости с множеством других библиотек конфигурации, а также его легко использовать в настройке проекта с мультизагрузчиком, в основном для использования в моих модах.

Он имеет простой в использовании синтаксис на основе аннотаций, позволяющий максимально упростить создание новых файлов конфигурации.

Если вы являетесь пользователем мода, эта информация, скорее всего, вам не очень полезна. Однако, если вы разработчик модов и хотите использовать Lexiconfig в своих собственных проектах, прокрутите дальше до раздела «Разработка».

В настоящее время она не поддерживает другие библиотеки конфигурации, но по мере того, как я продолжаю ее обновлять, я буду добавлять больше совместимости к каждой из них, чтобы гарантировать, что она не конфликтует с другими и вместо этого может легко интегрироваться между ними.

Вот список текущих и запланированных интеграций различных библиотек конфигурации/API:

❌ - Неинтегрированный ✅ - Интегрированный ❓ - В процессе | Статус | Мод | | ------------- | ------------- | | ❌ | Конфигурация ткани | | ❌ | oωo конфигурация | | ✅ | Настроен | | ❌ | Экраны конфигурации Forge |

Развитие

Этот мод содержит API, который можно использовать для хранения новых лексиконов, прослушивания событий и т. д.

В зависимости

build.gradle

repositories {
  maven { url 'https://maven.codinglitch.com/repository/releases' }
}

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

Вы можете перейти на https://versions.codinglitch.com, чтобы просмотреть последнюю версию API.

Использование

Чтобы положить на полку свои словари, вам сначала понадобится собственная библиотека. Это можно сделать, просто создав новый класс, расширяющий класс Library, и снабдив его аннотацией LexiconLibrary.

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

При настройке Forge никаких дополнительных изменений вносить не нужно. Однако если вы разрабатываете для Fabric, вам придется добавить этот класс в качестве точки входа в ваш Fabric.mod.json.

ткань.mod.json

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

Следующий шаг — наконец создать и положить на полку свои словари. Вы можете сделать это, просто создав еще один класс для словаря и снабдив его соответствующими аннотациями, например:

@Lexicon(name = MY_LEXICON_TITLE) // 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;
  }
}

Следующий и последний шаг — отложить словарь на хранение, что можно сделать, просто добавив его экземпляр в качестве поля в библиотеке и отложив его в данном методе.

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