Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add LethalAnalytics API docs to the wiki! Fix the APIs overview page. #125

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

RoosterBooster007
Copy link

I added my library to the Programming APIs tab/section of the wiki. Please let me know if I'm missing anything. I also fixed the APIs overview page (some stars were missing).

@Hamunii
Copy link
Contributor

Hamunii commented Jun 23, 2024

This is just my opinion and I have no authority on this wiki, but I really don't like the telemetry being opt-out rather than opt-in. And especially the language and region information is a bit creepy to me (since I don't really see how it's useful either). And actually a lot of the telemetry things that's collected by default I don't really get how they are that useful for the development of LethalAnalytics. I just don't feel good about this.

If it was opt-in though and very clear about this, I'd be fine with it, like maybe having a pop-up when you open the game that asks if you want to opt-in to data collection. Preferably also keeping track and showing which mods have given the permission to collect data.

@RoosterBooster007
Copy link
Author

@Hamunii I understand. I agree that implementing some sort of opt-in pop-up (or at least some kind of notification) would be a good idea. I'm looking into it.

And especially the language and region information is a bit creepy to me

Some people may find locale data intrusive or inappropriate but it can be really helpful to know what translations would be popular with your mod's userbase. Region/city-level reporting can also tell developers whether errors or certain events may be tied to a general area.

GitHub collects user locale data and more:
image
(a POST sent to https://collector.github.com/github/collect in the background as I was typing this reply)

I don't really get how they are that useful for the development of LethalAnalytics

Right now, the only unique events sent by the LethalAnalytics mod include information about what mods have registered a session (what mods use LethalAnalytics), how many total events have been sent (but not any of their contents), and when a user opens their quick menu (this last one isn't really that insightful tbh). This would just help me understand what mods/types of mods are interested in analytics and possibly how much data (events) are sent. In some cases, I may be able to reach out to a dev. if their mod is sending an abnormal amount of events (if I could even narrow it down).

Preferably also keeping track and showing which mods have given the permission to collect data.

I'm sure you've read it over but LethalAnalytics uses LethalConfig to show users which mods are sending analytics events, as well as to allow users to disable analytics for each or all mods entirely. Mods which register sessions must provide information about what data they are collecting and why they're collecting it so that users can make informed decisions (right within the config menu).

Anyway, I appreciate your input and am happy to help resolve any concerns.

@Hamunii
Copy link
Contributor

Hamunii commented Jun 25, 2024

@RoosterBooster007 okay yeah I do see how language and region can be useful, though only like a handful of mods do actually support multiple languages, and also generally mods don't do stuff where region would matter. This stuff just makes me a bit uncomfortable.

Anyways, what player do in-game, I don't really care how much data about that is collected, and I can definitely see how this can be useful.

I don't really have much else to say, other than just that as long as it's opt-in and clear about what is collected, I'm fine with it. It would be even better if the language, region and all potentially personal data was separate so you didn't have to also give out that data if you are otherwise fine with giving away gameplay data.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants