Customization policy
The following is the full Customization Policy regarding the customization of wikis on the wiki.gg platform using files, css, js, or other methods of changing the appearance or display of the wiki and its contents.
If something is not covered in this policy, or you have questions concerning it or other customization questions, please reach out to wiki.gg staff.
Assets
- You must have a logo uploaded with the file name :File:Site-logo.png
- You must have a favicon uploaded with the file name :File:Site-favicon.ico
- If you have a background image uploaded, it must be at most 1MB in size, under 500KB is highly recommended (using .jpg file format and compressing with either https://tinypng.com/ or https://squoosh.app/ is recommended)
- Files used in CSS must be uploaded locally and not point to external sites. Linking to files on other wiki.gg wikis is permitted where it makes sense for the styles to be synced, such as wikis covering the same topic in different languages. External links are allowed only where it's not otherwise possible, such as for Discord widgets where the banner image regularly updates.
Colors & accessibility
- Do not add a custom cursor to your wiki. Custom cursors are prohibited. There are no exceptions to this rule.
- Custom fonts are allowed, but you must pick a legible font. What constitutes a legible font is decided by wiki.gg staff.
- Page titles (
h1
) have a bit more flexibility than body text since they are displayed in a bigger font size. - You may also include additional themes beyond the default light/dark that have more "fun" fonts, for example if you wanted to create a "terminal" theme then a monospace font would be fine. You can add themes at MediaWiki:Theme-definitions .
- Page titles (
- You must include a link to Recent changes in your sidebar. Do this using the text
* recentchanges-url|recentchanges
. These strings will automatically be translated by the software, and they'll provide the hotkeyAlt/Opt+Shift+R
to navigate to Recent changes from any other page on the wiki.- If you want to change the text display, you may edit the page
MediaWiki:recentchanges
. - more info about recentchanges
- If you want to change the text display, you may edit the page
- Text elements must have enough contrast with their background to be easily legible. If your wiki has multiple themes, this applies to all of them.
- Inline color styling is discouraged because it makes it difficult to maintain this contrast on multiple themes.
- If your wiki is using an up-to-date version of the default loadout, Mediawiki:common.css/doc can help with this.
- You can use a contrast checker to check your contrast levels, or a contrast finder to help you pick new colors. Please meet at least AA standard.
Animated & moving content
Avoid excessive or repeating animations, especially on the main page. In particular, the following are discouraged:
- Animated gifs as a background image, border image, or other decorative asset
- Automatically-advancing slideshow galleries
The following are permitted:
- Including gifs that are important game assets on a character or other subject page, but it is recommended that they be in a gallery near the bottom of the page
- Spinners that display temporarily to indicate that something is loading
- Indicator movement on user-initiated state change
Links
- Your links must be easily distinguishable from regular text.
- Regular links may not be red or similar colors. Red is reserved for links to pages that don't exist (aka "redlinks").
- Links to pages that don't exist ("redlinks") must be red.
- Using the same color for links as for regular text is allowed if you use an underline for your links.
wiki.gg
- Don't alter the appearance of the wiki.gg header or cookie consent notice in any way without first getting approval from wiki.gg staff.
- Getting approval:
- If another wiki has made a change to one of these with approval, you may copy this change without permission; however, you may not make any alterations. If you want to make alterations, you must get approval from staff.
- To request a review for approval, please submit this form with a description of your modifications and a screenshot or links to relevant styles or scripts.
- You are responsible for ensuring that your own wiki is approved!
- Requests to change branding color in the netbar are never approved.
- Exceptions:
- You may add custom icons to a list of themes if you have 3+ themes and ThemeToggle is displaying a dropdown.
- You may style the cookie notice to fit with your wiki's theme as long as the notice stays easy to read.
- Getting approval:
- Don't alter the display or appearance of advertisements in any way.
- Don't hide/edit the content or appearance of content licensing in the wiki footer, file licensing templates, or other legal notices, without staff permission.
- Don't modify wiki.gg staff user flairs - this includes hiding staff user flairs on your wiki or using the wiki.gg logo as a flair for any user who is not wiki.gg staff.
- If you want local flairs for some users, this IS permitted, as long as the image or styling you choose will clearly not be conflated with wiki.gg staff user flairs by a typical wiki user.
Personal styles
Custom styles created by editing Special:MyPage/common.css are only visible to yourself. Thus, on this personalized page, there are no rules, since they will affect no one other than yourself.
Gadgets
Gadgets that are opt-in (not marked as default) have reduced restrictions. They may ignore rules from the #Colors & accessibility section above, but not the #wiki.gg section. This is the recommended approach if you really want say, a custom cursor or a discouraged feature.
Additional accessibility concerns
Requirements listed here may be more difficult to adhere to than the requirements in other sections if you are customizing your theme significantly. Therefore, we are issuing them as strong recommendations; we do not permit deliberately violating them, but please don't feel too much stress about adhering to them either.
If you think you have to violate one of these accessibility guidelines to make your theme work, please ask wiki.gg staff for help!
- Font sizes must be in units of
rem
orem
. Do not use pixel values for fonts. This especially holds in body text. - Consider mobile responsiveness when designing all aspects of the site, including:
- The main page
- Images (our default loadout has a
responsive-image
class you can apply to wide images) - Tables, especially wide tables
- Templates
Duty of best-effort
If you have access to edit your wiki's styles, you have a duty to make best-effort edits that do not make the wiki unusable, even temporarily. Please don't let this policy frighten you; if your intention is to make working CSS, this rule will likely never apply to you.
Examples:
- Not in violation: if you accidentally leave off a
}
in your stylesheet and the wiki's styles are broken for a day before anyone notices, this is an accident and not in violation of this policy. We'd just ask you to be a bit more careful in the future. - Not a violation: if you push new code for tables that you think works, but then it turns out to be broken, and you fix it or roll it back as soon as you find out, this is an accident and not in violation of this policy. Again, we'd just ask you to be a bit more careful in the future.
- Violation: if you decide that you think mobile sucks and you deliberately remove every responsive design element, this is a violation.
- Violation: if you push CSS that you know is breaking every table on the wiki in a major way, but you plan to fix it in 2 weeks, this is a violation. Please keep experiments on sandboxes when you know for certain that they don't work.