Archipelago/WebHostLib
Aaron Wagener 430b71a092
Core: have webhost slot name links go through the launcher (#2779)
* Core: have webhost slot name links go through the launcher so that components can use them

* fix query handling, remove debug prints, and change mousover text for new behavior

* remove a missed debug and unused function

* filter room id to suuid since that's what everything else uses

* pass args to common client correctly

* add GUI to select which client to open

* remove args parsing and "require" components to parse it themselves

* support for messenger since it was basically already done

* use "proper" args argparsing and clean up uri handling

* use a timer and auto launch text client if no component is found

* change the timer to be a bit more appealing. also found a bug lmao

* don't hold 5 hostage and capitalize URI ig

---------

Co-authored-by: NewSoupVi <57900059+NewSoupVi@users.noreply.github.com>
2024-09-08 00:03:04 +02:00
..
api WebHost: allow getting checksum-specific datapackage via /api/datapackage/<checksum> (#3451) 2024-06-08 05:07:14 -04:00
static Docs: Removing #archipelago-dev from places (#3876) 2024-09-05 22:55:19 +02:00
templates Core: have webhost slot name links go through the launcher (#2779) 2024-09-08 00:03:04 +02:00
README.md Explaining the "Style Lockdown" (#940) 2022-08-22 19:01:21 -04:00
__init__.py WebHost: Massive overhaul of options pages (#2614) 2024-05-18 00:11:57 -04:00
autolauncher.py WebHost: properly stop worker threads (#3340) 2024-05-19 20:40:36 +02:00
check.py WebHost: check: display exception chain one layer deep (#3153) 2024-04-15 21:26:59 -04:00
customserver.py customserver: fix memory leak (#3864) 2024-09-01 20:34:50 +02:00
downloads.py Final Fantasy Mystic Quest: Implement new game (#1909) 2023-11-26 17:17:59 +01:00
generate.py WebHost: use settings defaults for /api/generate and options -> Single Player Generate (#3411) 2024-05-29 16:53:18 +02:00
landing.py WebHost: optimize imports 2022-10-17 01:24:02 +02:00
locker.py Core, WebHost: lazy-load worlds in unpickler, WebHost and WebHostLib (#2156) 2023-09-20 16:05:56 +02:00
lttpsprites.py WebHost: Fixed warning ".gitignore dropped, as it has no valid sprite data." (#1174) 2022-11-02 19:06:00 +01:00
misc.py WebHost: Log: handle FileNotFoundError (#3603) 2024-07-02 01:03:55 +02:00
models.py WebHost: index columns used by landing page. 2023-05-21 05:01:29 +02:00
options.py WebHost: Fix NamedRange values clamping to the range (#3613) 2024-07-29 20:13:44 -04:00
requirements.txt WebHost: update dependencies (#3871) 2024-09-03 02:31:42 +02:00
robots.py WebHost: fix accidental robots.txt capture (#3502) 2024-06-21 14:54:19 +02:00
stats.py Docs: datapackage typing (#1229) 2022-11-27 19:25:53 -06:00
tracker.py Fix obvious typo (#3622) 2024-07-28 00:44:48 -04:00
upload.py WebHost: Prevent committing data packages with invalid checksums to database and prevent 500 error from invalid `zip` files. (#3206) 2024-04-26 22:18:12 -04: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.