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

get5_backup_system_enabled and other undocumented cvars #571

Closed
nickdnk opened this issue Sep 27, 2020 · 4 comments · Fixed by #752
Closed

get5_backup_system_enabled and other undocumented cvars #571

nickdnk opened this issue Sep 27, 2020 · 4 comments · Fixed by #752

Comments

@nickdnk
Copy link
Collaborator

nickdnk commented Sep 27, 2020

It seems the get5_backup_system_enabled cvar is not part of the wiki, which instead says the timer should be set to 0 to disable the system: https://github.com/splewis/get5/wiki/Full-list-of-get5-cvars - so which one is it?

Also, these cvars are missing from the wiki as well.
get5_display_gotv_veto
get5_pretty_print_json
get5_server_id
get5_set_client_clan_tags
get5_veto_confirmation_time

I can create a PR to add them based on the get5.cfg file if you want.

@splewis
Copy link
Owner

splewis commented Sep 27, 2020

The source of truth for what the defaults are / what the behavior is would be the code: https://github.com/splewis/get5/blob/master/scripting/get5.sp#L251-L338

The problem with github wiki sis that it can't accept PRs. Feel free to copypaste the new contents and I'll update the page, though. I had wanted to move the wiki content to internal markdown files so they could accept PRs, but I didn't get around to that.

@nickdnk
Copy link
Collaborator Author

nickdnk commented Sep 28, 2020

The source of truth for what the defaults are / what the behavior is would be the code: https://github.com/splewis/get5/blob/master/scripting/get5.sp#L251-L338

While that's true it kind of defeats the purpose of having documentation in the first place. Heh.

I haven't worked with Github wikis, but I'd support having the docs as part of the repo to make sure merged changes always include updated documentation as well. I can do that.

@splewis
Copy link
Owner

splewis commented Sep 29, 2020

While that's true it kind of defeats the purpose of having documentation in the first place. Heh.

Agreed! I was just mentioning as the best way to answer any question on cvar defaults/behavior authoritatively.

@PhlexPlexico PhlexPlexico linked a pull request Jun 23, 2022 that will close this issue
@PhlexPlexico
Copy link
Collaborator

Linking the docs PR to this as this should make it so users can contribute freely to documentation and have it automatically updated upon merge.

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

Successfully merging a pull request may close this issue.

3 participants