monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Archipelago/WebHostLib
History
alwaysintreble 4c0c93b083
core: allow string defaults in yaml templates (#1051) 
* allow string defaults in yaml templates

* have default_converter handle strings

* handle all default values in the yaml

* allow for random range options

* yaml dump dicts

* strip the whities

* rip out the converter

* accidentally stripped the dicts

* goodbye readability
 		2022-10-10 00:16:59 +02:00
..
api Core remove legacy patch (#1047) 2022-09-30 00:36:30 +02:00
static WebHost: Fixed some document titles (#1063) 2022-10-06 18:01:07 -04:00
templates core: allow string defaults in yaml templates (#1051) 2022-10-10 00:16:59 +02:00
README.md Explaining the "Style Lockdown" (#940) 2022-08-22 19:01:21 -04:00
__init__.py Core remove legacy patch (#1047) 2022-09-30 00:36:30 +02:00
autolauncher.py WebHost: allow customserver to skip importing worlds subsystem for hosting a Room (#877) 2022-08-07 18:28:50 +02:00
check.py Generate: convert plando settings to an IntFlag with error reporting for unknown plando names (#735) 2022-07-03 14:11:52 +02:00
customserver.py WebHost: CustomServer: use defaultdicts 2022-09-19 01:20:36 +02:00
downloads.py Core remove legacy patch (#1047) 2022-09-30 00:36:30 +02:00
generate.py WebHost: cleanup generate and hopefully fix SQL concurrency problems 2022-07-16 19:44:29 +02:00
landing.py update landing with dynamic links and counter for Seeds 2020-08-13 09:23:52 +02:00
lttpsprites.py Setup, Launcher, Linux Support (#359) 2022-03-31 05:08:15 +02:00
misc.py Docs: Ensure Discord links are permanent. (#1064) 2022-09-29 23:15:12 +02:00
models.py WebHost: reduce server uptime (#794) 2022-07-18 21:10:29 +02:00
options.py core: allow string defaults in yaml templates (#1051) 2022-10-10 00:16:59 +02:00
requirements.txt Core: update modules 2022-09-03 09:55:47 +02:00
stats.py Stats: limit to recognized games 2022-08-05 17:01:02 +02:00
tracker.py Core remove legacy patch (#1047) 2022-09-30 00:36:30 +02:00
upload.py Core remove legacy patch (#1047) 2022-09-30 00:36:30 +02:00

README.md

WebHost

Contribution Guidelines

Thank you for your interest in contributing to the Archipelago website!
Much of the content on the website is generated automatically, but there are some things that need a personal touch. For those things, we rely on contributions from both the core team and the community. The current primary maintainer of the website is Farrak Kilhn. He may be found on Discord as Farrak Kilhn#0418, or on GitHub as LegendaryLinux.

Small Changes

Little changes like adding a button or a couple new select elements are perfectly fine. Tweaks to style specific to a PR's content are also probably not a problem. For example, if you build a new page which needs two side by side tables, and you need to write a CSS file specific to your page, that is perfectly reasonable.

Content Additions

Once you develop a new feature or add new content the website, make a pull request. It will be reviewed by the community and there will probably be some discussion around it. Depending on the size of the feature, and if new styles are required, there may be an additional step before the PR is accepted wherein Farrak works with the designer to implement styles.

Restrictions on Style Changes

A professional designer is paid to develop the styles and assets for the Archipelago website. In an effort to maintain a consistent look and feel, pull requests which exclusively change site styles are rejected. Please note this applies to code which changes the overall look and feel of the site, not to small tweaks to CSS for your custom page. The intention behind these restrictions is to maintain a curated feel for the design of the site. If any PR affects the overall feel of the site but includes additive changes, there will likely be a conversation about how to implement those changes without compromising the curated site style. It is therefore worth noting there are a couple files which, if changed in your pull request, will cause it to draw additional scrutiny.

These closely guarded files are:

  • globalStyles.css
  • islandFooter.css
  • landing.css
  • markdown.css
  • tooltip.css

Site Themes

There are several themes available for game pages. It is possible to request a new theme in the #art-and-design channel on Discord. Because themes are created by the designer, they are not free, and take some time to create. Farrak works closely with the designer to implement these themes, and pays for the assets out of pocket. Therefore, only a couple themes per year are added. If a proposed theme seems like a cool idea and the community likes it, there is a good chance it will become a reality.