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

Missing game mechanics documentation - PR discussion #522

Open
AnonymousDapper opened this issue Feb 3, 2025 · 3 comments
Open

Missing game mechanics documentation - PR discussion #522

AnonymousDapper opened this issue Feb 3, 2025 · 3 comments
Labels
needs triage This is a new issue that needs to be reviewed.

Comments

@AnonymousDapper
Copy link

Problem

Official hackmud wiki is lacking clear/sufficient documentation for core game mechanics including user slots, security levels and their possible consequences, badges/GC, and sectors. (Essentially, most of the topics on Fandom's Game Mechanics page)

I'm aware sectors are mentioned in the glossary, but I don't believe that entry is a sufficient explanation.

Context

I propose to create a new navbar entry titled "Game Mechanics" with sub-entries including the aforementioned topics as individual pages.

Alternatively, I can add only a page on security levels and put it in the New Players guide. I think a separate navbar entry is a better idea, as it allows for the other topics to be easily added in future.

FWIW: I'm already in the process of writing a Security Levels page.

@AnonymousDapper AnonymousDapper added the needs triage This is a new issue that needs to be reviewed. label Feb 3, 2025
@AnonymousDapper
Copy link
Author

AnonymousDapper commented Feb 3, 2025

Page skeleton for critique:

I am aware the CLI/subscript behavior of scripts.get_level is already documented elsewhere. I'm open to removing it from this page.

seclevel page WIP

@matr1x-hackmud
Copy link
Member

matr1x-hackmud commented Feb 3, 2025

An extra navbar entry for miscellaneous game mechanics probably makes a lot of sense, either one with a hover-dropdown or one you just click to get an autogenerated index page.

My mind so far is on starting with a hover-dropdown for Game Mechanics, and I'd be happy reviewing a PR to add that.

I like the current look of your seclevels page! I saw you mentioned Fandom - when using external references, just be mindful of respecting existing content licenses.

@AnonymousDapper
Copy link
Author

Sounds good. When I get more time I'll build out the skeleton for a new dropdown and PR it.

"licensing restrictions" is so wild to me.. ComCODE owns the game they're hosting an article about

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs triage This is a new issue that needs to be reviewed.
Projects
None yet
Development

No branches or pull requests

2 participants