Archipelago/WebHostLib
Doug Hoskisson 265ee7098a
New Game: Zillion (#1081)
* Option RangeWithSpecialMax

* amendment to typing in web options

* compare string with number

* lots of work on zillion

* fix zillion fill logic

* fix a few more issues in zillion fill logic

* can make zillion patch and use it

* put multi items in zillion rom

* work on ZillionClient

* logging and auth in client

* work on sending and receiving items

* implement item_handling flag

* fix locations ids to NuktiServer package

* use rewrite of zri

* cache logic rule data for performance

* use new id maps

* fix some problems with the big recent merge

* ZillionClient: use new context manager for Memory class

* fix ItemClassification for Zillion items
and some debug statements for asserts,
documentation on running scripts for manual testing
type correction in CommonContext

* fix some issues in client, start on docs, put rescue and item ram addresses in slot data

* use new location name system
fix item locations getting out of sync in progression balancing

* zillion client can read slot name from game

* zillion: new item names

* remove extra unneeded import

* newer options (room gen and starting cards)

* update comment in zillion patch

* zillion non static regions

* change some logging, update some comments

* allow ZillionClient to exit in certain situations

* todo note to fix options doc strings

* don't force auto forfeit

* rework validation of floppy requirement and item counts
and fix race condition in generate_output

* reorganize Zillion component structure
with System class

* documentation updates for Zillion

* attempt inno_setup.iss

* remove todo comment for something done

* update comment

* rework item count zillion options
and some small cleanups

* fix location check count

* data package version 1

* Zillion can pass unit tests without rom

* fix freeze if closing ZillionClient while it's waiting for server login

* specify commit hash for zilliandomizer package

* some changes to options validation

* Zillion doors saved on multiworld server

* add missing function in inno_setup
and name of vanilla continues in options

* rework zillion sync task and context

* Apply documentation suggestions from SoldierofOrder

Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>

* update zillion package

* workaround for asyncio udp bug

There is a bug in Python in Windows
https://github.com/python/cpython/issues/91227
that makes it so if I look for RetroArch before it's ready, it breaks the asyncio udp transport system.

As a workaround, we don't look for RetroArch until the user asks for it with /sms

* a few of the smaller suggestions from review

* logic only looks at my locations
instead of all the multiworld locations

* some adjustments from pull request discussion
and some unit tests

* patch webhost changes from pull request discussion

* zillion logic tests

* better vblr test

* test interaction of character rescue items with logic

* move unit tests to new worlds folder

* comment improvements

* fix minor logic issue
and add memory read timeout

* capitalization in option display names
Opa-Opa is a proper noun

* redirect zz stdout to debug

* fix option validation bug making unbeatable seeds

* remove line that does nothing

* attach logic cache to world

Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>
Co-authored-by: Doug Hoskisson <doughoskisson@novuslabs.com>
2022-10-20 19:41:11 +02:00
..
api WebHost: optimize imports 2022-10-17 01:24:02 +02:00
static WebHost: Fixed scrolling to anchors (#1085) 2022-10-14 17:09:17 -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 WebHost: optimize imports 2022-10-17 01:24:02 +02:00
autolauncher.py WebHost: optimize imports 2022-10-17 01:24:02 +02:00
check.py WebHost: optimize imports 2022-10-17 01:24:02 +02:00
customserver.py WebHost: optimize imports 2022-10-17 01:24:02 +02:00
downloads.py New Game: Zillion (#1081) 2022-10-20 19:41:11 +02:00
generate.py WebHost: optimize imports 2022-10-17 01:24:02 +02:00
landing.py WebHost: optimize imports 2022-10-17 01:24:02 +02:00
lttpsprites.py Setup, Launcher, Linux Support (#359) 2022-03-31 05:08:15 +02:00
misc.py WebHost: optimize imports 2022-10-17 01:24:02 +02:00
models.py WebHost: optimize imports 2022-10-17 01:24:02 +02:00
options.py WebHost: optimize imports 2022-10-17 01:24:02 +02:00
requirements.txt Core: update modules 2022-09-03 09:55:47 +02:00
stats.py WebHost: optimize imports 2022-10-17 01:24:02 +02:00
tracker.py WebHost: optimize imports 2022-10-17 01:24:02 +02:00
upload.py WebHost: optimize imports 2022-10-17 01:24:02 +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.