属性

fStats

面向开发者的 Fabric 指标系统
支持 · 报告 Bug · 请求功能

关于本项目

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 内可用（它只有约 9KB！）
    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 内可用，它只有约 9KB！
    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 时，你就可以在网站上获取相关数据。

此外，建议在你的项目描述中添加徽章，以告知用户你正在收集信息。

可将徽章调整为任意大小

(返回顶部)

路线图

请查看待解决问题以获取完整的拟议功能列表（以及已知问题）。

(返回顶部)

贡献

贡献正是开源社区如此令人惊叹、可供学习、激发灵感与创造的原因。你所做的任何贡献都备受赞赏。

如果你有改进建议，请 fork 仓库并创建 pull request。你也可以简单地提交一个带有 "enhancement" 标签的 issue。 别忘了给项目点个 star！再次感谢！

1. Fork 本项目
   1. 创建你的功能分支（git checkout -b feature/AmazingFeature）
   2. 提交你的更改（git commit -m 'Add some AmazingFeature'）
   3. 推送到分支（git push origin feature/AmazingFeature）
   4. 打开一个 Pull Request

(返回顶部)

许可证

在 MIT 许可证下分发。更多信息请参见 LICENSE.txt。

(返回顶部)