fStats

!Contributors !Forks !Stargazers !Issues !MIT License !LinkedIn !Discord !Modrinth

fStats

Система сбора метрик на Fabric для разработчиков
Поддержка · Сообщить об ошибке · Предложить функцию

О проекте

fStats — сторонняя библиотека для сбора метрик. Основная идея — помочь разработчикам узнать свою реальную аудиторию на основе графиков

(наверх)

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

Для пользователей

У мода есть конфиг, который позволяет отключить сбор метрик с сервера/клиента и скрыть местоположение

../config/fstats-api/config.json

{
    "enabled": true,      // Включить/отключить сбор с нашего сервера
    "hideLocation": false // Мод не собирает ваш IP, только название страны 
}

Для разработчиков

Первое, что нужно сделать — зарегистрироваться и создать проект, чтобы получить projectId

repositories {
    maven {
        url "https://api.modrinth.com/maven"
    }
}

dependencies {
    // Вариант 1: Включить fStats API в проект, чтобы он был доступен внутри вашего jar (ЭТО ВСЕГО ~9КБ!)
    include(modImplementation("maven.modrinth:fstats:<version>")

    // Вариант 2: Зависеть от fStats API, но требовать, чтобы пользователи устанавливали его вручную
    modImplementation "maven.modrinth:fstats:<version>"
}

repositories {
    maven("https://api.modrinth.com/maven")
}

dependencies {
    // Вариант 1: Включить fStats API в проект, чтобы он был доступен внутри вашего jar ЭТО ВСЕГО ~9КБ!
    include(modImplementation("maven.modrinth", "fstats", "<version>"))

    // Вариант 2: Зависеть от fStats API, но требовать, чтобы пользователи устанавливали его вручную
    modImplementation("maven.modrinth", "fstats", "<version>")
}

fabric.mod.json

"suggests": {
    "fstats-api": "*"
}

Настройка проекта

fabric.mod.json

"custom": {
    "fstats": <projectId>
}

Готово, теперь когда любой сервер использует ваш мод и не отключает fStats, вы будете получать данные об этом на сайте

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

Измени размер значка на любой, какой захочешь

(наверх)

Планы

Смотрите открытые задачи, чтобы увидеть полный список предложенных функций (и известных проблем).

(наверх)

Участие в разработке

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

Если у вас есть предложение, как сделать это лучше, форкните репозиторий и создайте pull request. Также можно просто открыть задачу с тегом "enhancement". Не забудьте поставить проекту звезду! Ещё раз спасибо!

1. Форкните проект 2. Создайте ветку для своей функции (git checkout -b feature/AmazingFeature) 3. Закоммитьте изменения (git commit -m 'Add some AmazingFeature') 4. Запушьте ветку (git push origin feature/AmazingFeature) 5. Откройте Pull Request

(наверх)

Лицензия

Распространяется под лицензией MIT. Подробнее см. в LICENSE.txt.

(наверх)