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

Manual validation run for room owners #33

Open
RePod opened this issue Dec 7, 2024 · 4 comments
Open

Manual validation run for room owners #33

RePod opened this issue Dec 7, 2024 · 4 comments

Comments

@RePod
Copy link
Contributor

RePod commented Dec 7, 2024

When rooms that have validation disabled allow a manual validation run to catch surface level problems.
For example, the latest Hades release provides template YAMLs with outdated key names. Yes, this would be caught if the submitter solo genned and if the room had validation enabled, but this mitigates a downside of disabling validation(...) and can inform room owners ahead of time.

Easy mode:

  • Ignore/warn games not tracked by the lobby
  • Rate limit of course

Easy NG+ mode:

@Eijebong
Copy link
Owner

Eijebong commented Dec 7, 2024

It is something that's been on my mind for a while because of lobby generation. Here's my braindump about it from a few weeks ago:

  1. I add a validation status to YAMLs.

    • Validated (it's been validated by the checker itself, I know for sure it's good)
    • Manually validated (it's been vetted by the author of the room, it might be bad but at least someone should've looked at it...)
    • Non validated
  2. I add a colored circle next to YAMLs for the room author. Green if validated, light green if manually validated, red if non validated. IIF they have validation on, otherwise don't care.

  3. Depending on the YAML validation state:

    • If it's Validated clicking that circle does nothing
    • If it's Manually validated, give an option to invalidate it and an option to throw it at the YAML checker.
    • If it's Non validated, give an option to throw it at the checker and an option to mark it as Manually validated
  4. In the room options, I change a few settings:

    • I remove/change the option to enable validation or not:
    • I add an APWorlds that shouldn't get validated by the lobby, a free form list that autocompletes with apworlds present in the room. When a YAML matches that, I just set their status as Non validated and upload them.
    • I add an option to not validate anything
    • I add an option only emit a warning when validation fails
    • I add a Forbidden apworlds, same kind of list. Those would not be allowed in the room at all.

@RePod
Copy link
Contributor Author

RePod commented Dec 7, 2024

I add a colored circle next to YAMLs for the room author.

If it's not demanding, validation status should be visible to everybody who can see the room.

Green if validated, light green if manually validated, red if non validated. IIF they have validation on, otherwise don't care.

May need to include icons or text + / ~ / -.

@Eijebong
Copy link
Owner

Eijebong commented Dec 7, 2024

Yup, that was a brain dump I made, haven't re-read any of it but your input is very welcome, thank you

@Eijebong
Copy link
Owner

Eijebong commented Jan 5, 2025

A few more thoughts about this:

We can automatically revalidate YAMLs when an apworld changes in the room in 2 places.

  1. When the room gets saved and is open
  2. After the lobby refreshes its index, on all open rooms

The main issue with that is knowing what to revalidate. The validation status should probably contain the apworlds/versions the YAML has been checked with.

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

No branches or pull requests

2 participants