Wiki/Style guide
This is a meta article! It revolves around something within the wiki, and is not necessarily an article about Housing!
The Hypixel Housing Wiki should always stay high quality, that's why we employ a style guide on what to do and what not to do when contributing to a page. If you are wondering about something like usage of the Oxford comma or British vs American English, refer to the Wikipedia Manual of Style.
Do's and don'ts
When writing a page, it's hard to uphold a quality standard. While we very rarely delete pages, we do look at improving any page of a low quality. Here's some quick examples of what you should and shouldn't do when writing!
We do not ban anyone for making a bad page or two, but if you repeatedly make low quality submissions we may suspend you for a bit so you have a chance to read up on the style manual.
General advice
When writing, keep these things in mind:
- Try to use the terminology list
- Don't overuse links, and don't link to Housing or Systems unless it's actually relevant to the page. In the sentence "Carpenter is Housing's only NPC with dialogue" you wouldn't link to Housing, because it's not really relevant to the point and a ton of people know what Housing is.
- Don't capitalise everything unless it's gramatically correct. If it's lowercase in the terminology, keep it lowercase.
- Follow Wikipedia's text formatting rules, e.g. bolding the title of the page in the first sentence.
- Compare your page to other pages and how they're formatted. If it looks different, it probably isn't a good thing.
- Avoid trivia sections as they can become very bloated very fast, instead opt for weaving them into the article directly.
- Avoid jokes. While we like humour, it isn't meant for documentation as it can distract the reader.
- Avoid comments (hey, someone make this sentence better!) like that one right there. Readers see this, we have a Discord server to talk in and ask for feedback in, as well as a discussion tab. You do not need to be placing comments in your articles.
Terminology
To stay consistent and not confuse new players, this is the vocabulary that should be used in guides and pages. If a term is missing, please mention it in our Discord server listed on the main page and we'll add it!
Generally, the order of priority on how things should be referred to are as follows, although exceptions may be made. If any non-community phrases conflict, the most recent one should be used if it is not yet listed.
- Phrase is used ingame
- Phrase is used in changelogs
- Phrase is used by the playerbase
- Phrase is used in developer posts
| Category | Phrase | Definition/Usage |
|---|---|---|
| Actions | an action holder | Any context where actions can be inputted, such as events, NPCs and action buttons. |
| Actions | an action chain/set | All actions within an action holder. Chain is preferable to set. |
| Actions | the action list | The list of all actions available to pick from. |
| Actions | to trigger | To run a chain of actions. |
| Technical | Digit array | A technical type of stat where each digit is it's own independent number from 0-9 |
| Technical | Boolean array | A technical type of stat where complex math is used to store 63 booleans in a singular stat. |
| Technical | Bitfield | A technical type of stat where complex math is used to store 63 bits of data in a singular stat. |