The Manual of Style is the style manual that will be used for all mainspace pages that are within the Regretevator Wiki. These guidelines are made to make sure that the pages can be read without confusion, and to improve the quality of the wiki's pages.
It can also be used when there is a disagreement about which style to use on articles. Also, most of this page uses the Source Editor for examples, and not the Visual Editor.
Last modified on July 16, 2024
Gathering information from reliable sources
When editing, it is absolutely necessary to link official and trusted sources if there is any that you might know of.
To get trustable sources, you need to go the official AxoSun Discord server (which you can go to here), or a developer's social media page (e.g Twitter and/or Tumblr). If a vital piece of information (e.g floor/NPC trivia) does not have any reliable sources linked towards it, it must be removed immediately.
When you are also putting in game artwork, be sure to credit them.
General rules and statements
This section will cover a few important statements regarding editing.
- Users are required to follow FANDOM's Terms of Use and the wiki policy at all times while editing.
- The Manual of Style is not necessary for userpages or blogs, only for mainspace pages.
- This wiki prioritizes British English, however American English can also be used as well.
- Do not add notes to a page.
- Examples: "Page creator: Tricolorpaulista6331, "pls add more info", "thanks to regretevatorbigfan1 for editing".
- Vandalism can be reverted by clicking on the three dots right next to the Edit button, then click on View History > Previous revision before vandalization > Edit > Save.
- Article's names can be changed by clicking on the three dots and clicking Move.
- If a modification to a template is done and you do not see an update to the page said template is used on, use the Purge function. This will reset all server caches on the page, and update it to its current version.
- If you wish to replace a file, instead of uploading a whole new file with the "Upload File" tab, simply click the image you wish to replace and click "Upload a new version of this file."
- Please use a third-person perspective when editing pages on the wiki. (Examples: Replace "you can.." with "the player can..")
Image quality
When placing in screenshots from the main game (or any other Regretevator-related game made by The Axolotl Sun), please have said image's quality at the highest, if possible. Low-quality screenshots are to be removed immediately, and to be replaced with a better-quality image.
Grammar
- Use correct punctuation:
- What you shouldn't do: It's color is blue.
- What you should do: Its color is blue.
- The word "its" is often used in reference to something owned by a person or thing previously mentioned in the sentence.
- "It’s" is a contraction meaning it is or it has.
- What you shouldn't do: It's color is blue.
- Capitalize sentences properly:
- What you shouldn't do: this floor is very huge.
- What you should do: This floor is very huge.
- What you shouldn't do: this floor is very huge.
Structures
Floors
Pages regarding Floors must contain the following structures.
- Appearance
- This section must describe the floor's appearance.
- Example: The floor appears as a furniture store, with fog covering up the walls and the roof. The furniture store is divided by a white-colored pathway into many sections, examples being a living room plot, a children's plot, or a weapons plot. Several advertisement posters are hung with what seems to be metal.
- This section must describe the floor's appearance.
- Gameplay
- This section must contain the general concept of the floor.
- Example: The floor is heavily based on a game with the same name, that being 3008 by uglyburger0, which is also based off of SCP-3008. The song played in the floor is directly from the game's soundtrack. Unlike the original game, there are no pillars or employees. This floor cannot kill players and has one NPC named Lampert.
- This section must contain the general concept of the floor.
- Audio
- Only if the floor has dialogue or extra audio.
- Gallery
- Additional images of the floor.
- Trivia
- The Trivia section must only contain facts or additional information.
- Example: The "Day #" UI at the top of the screen corresponds to the floor number.
- The Trivia section must only contain facts or additional information.
NPCs
Pages regarding NPCs must contain the following structures.
- Appearance
- This section must describe the NPC's appearance.
- Example: Spud! is a blocky R6 character wearing a light gray bucket on his head and a blue bowtie. He has a white head and long arms acting as legs and a green shirt reading "CAMP COUNSELOUR SPUD" and "TWO STUD CAMP". He has two black oval eyes and a tilted smile between them.
- This section must describe the NPC's appearance.
- Description
- This section must contain the general concept of the NPC.
- Example: If the Two Stud Camp floor arrives, Spud! will enter the elevator saying "Spud!". If he is clicked, he will make a short "womp" sound.
- This section must contain the general concept of the NPC.
- Audio
- Only if the NPC has dialogue or extra audio.
- Gallery
- Additional images of the NPC.
- Trivia
- The Trivia section must only contain facts or additional information.
- Example: Spud! is afraid of loud distorted noises and tape recordings of violins.
- The Trivia section must only contain facts or additional information.
Items
Pages regarding Items must contain the following structures.
- Appearance
- This section must describe the item's appearance.
- Example: The Cheezburger appears as a burger with meat, alongside some toppings, such as a slice of cheese, and what seems to be a tomato slice. There is also two light-brown colored buns on the top and bottom of the burger with the top bun containing sesame seeds.
- This section must describe the item's appearance.
- Interaction
- This section must describe the item's function.
- Example: Sold at the GUI Shop for 2 coins, when used, it would regenerate 5% of said player's HP. This item has two different dialogues, one for when it is held, and one for when it is eaten. Afterwards, if the item had only been bought once, the item will be removed from the inventory list.
- This section must describe the item's function.
- Audio
- Only if the item has dialogue or extra audio.
- Gallery
- Additional images of the item.
- Trivia
- The Trivia section must only contain facts or additional information.
- Example: The Cheezburger is the cheapest item in-game, costing only 2 coins per purchase.
- The Trivia section must only contain facts or additional information.
Notices
This section will cover notices. They are templates that stay on top of the page that display important information.
Notices can be added by typing {{insert notice name}}.
Unreleased
The "Unreleased" notice is used for pages that contain unreleased content. Added by typing {{Unreleased}}.
"We're not ready yet!"
This article is about an unreleased feature, and may have information that is unreliable, or based off assumption. |
Delete
The "Delete" notice is used for pages who are candidates for deletion. Added by typing {{Delete}}.
You can add the deletion reason by typing {{Delete|Reason}}.
"Truly a Sears moment."
This article has now been marked for deletion. If this is a mistake, please notify an admin, before removing this template. |
Stub
The "Stub" notice is used for pages who require for more information to be added. Added by typing {{Stub}}.
"Uh oh! Something's gone wrong."
This article is a stub! Help out by filling in missing details or adding onto some information. |
Maintenance
The "Maintenance" notice (formerly Unknown) is used for pages that might contain unreliable information or based off assumption. Added by typing {{Maintenance}}.
"Something doesn't look right.."
This article contains some information that might not be reliable, or is only based off assumption. |
Removed
The "Removed" notice is used for pages that contain removed content from the game. Added by typing {{Removed}}.
You can add the reason by typing {{Removed|Reason}}.
"Wasn't something here before?"
This article is about a feature that is no longer in-game. |
Infoboxes
This section will cover infoboxes. Infoboxes are very important for the reader due to them containing general information about the article. <tabber>
Floor infobox
An example of how an infobox should be formatted, along with example text:
{{Floor template |title1=Page name |image1=Example.png |caption=Caption example |music=[https://www.youtube.com/watch?v=CI2Nz_3gSNI Music example] |length=Floor length |candamage=Yes/No |hasnpcs=Yes/No |interactswithnpcs=Yes/No }}
- Image
- The image must be high quality, and must have no on-screen GUI on it. A recommended tool for screenshotting is Lightshot, Snipping Tool, Snipm or Sketch.
- Caption (optional)
- Small text under the image.
- Music
- Add the music used on the floor.
- Length
- Add how much time the floor goes for.
- Can Damage/Kill
- Add if the floor can kill or damage players.
- Has NPCs
- Add if the floor has NPCs or not.
- Interacts with NPCs
- Add if the floor can interact with NPCs.
NPC infobox
An example of how an infobox should be formatted, along with example text:
{{NPC_template |title1=Page name |image1=Example.png |caption-image1=Caption example |Floor=[[Floor]] |pronouns=Pronouns example (He/Him, She/Her, etc.) |canenter=Yes/No |killable=Yes/No |hostile=Yes/No }}
- Image
- The image must be high quality, and must have no on-screen GUI on it. A recommended tool for screenshotting is Lightshot, Snipping Tool, Snipm or Sketch.
- Caption (optional)
- Small text under the image.
- Pronouns
- Add the NPC's confirmed pronouns. It's recommended to use source from Yeuc_c's Tumblr.
- Can Enter
- Add if the NPC can enter the elevator or not.
- Killable
- Add if the NPC can get killed or not.
- Hostile
- Add if the NPC can damage players.
Item infobox
An example of how an infobox should be formatted, along with example text:
{{Regretevator_Items |title=Page name |image1=Example.png |caption-image1= |price=6331 (Coins, Robux) |harmful=Yes/No |effect=Effect example }}
- Image
- The image must be high quality, and must have no on-screen GUI on it. A recommended tool for screenshotting is Lightshot, Snipping Tool, Snipm or Sketch.
- Caption (optional)
- Small text under the image.
- Price
- Add the item's in game price.
- Harmful
- Add if the NPC can damage players.
- Effect
- Add the item's function.
Miscellaneous
This section will cover on how to add other templates.
<gallery> File:Example.png </gallery>
{| class="fandom-table" !Audio !Description |- |[[File:Studentvoicechanges.wav]] (audio file)s |Audio's description |}
- References can be added by typing
<ref> (link) </ref>
next to the text you want to add it to, and then adding a Heading through== References ==
, and then including<references/>
underneath the heading.- Example:
Wallter is made out of concrete. <ref> https://www.tumblr.com/yeuc-c/731459433897574401 </ref> == References == <references/>
- If the page contains too many references, add this instead of only <references/> :
<small>'''Click "Expand" to see.''' </small> <div class="mw-collapsible mw-collapsed"> <references /></div>