monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
4,463 Commits 1 Branch 0 Tags 67 MiB
Commit Graph

96 Commits

Author SHA1 Message Date
Jarno Westhof dd6e212519 [Core] Colorama fix 2022-08-05 17:17:40 +02:00
black-sliver d817fdcfdb
Doc: move Running from source from wiki to docs (#797) 
* Doc: move "Running from source" from wiki to docs/

* Doc: update links and reformat running from source

* Doc: implement suggestions in "Running from source"

thanks @alwaysintreble

* Doc: update link to "Running from source"

also link docs/ folder

* Doc: Running from source: Apply suggestions from code review

Co-authored-by: KonoTyran <Kono.Tyran@gmail.com>

Co-authored-by: KonoTyran <Kono.Tyran@gmail.com>
 2022-07-29 01:18:59 +02:00
Jarno 9acaf1c279
[Docs] Further explained the mythical `InvalidPacket` (#828) 
* [Docs] Further explained the mythical `InvalidPacket`

* Fixed header category

* Update docs/network protocol.md

Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>

* Update docs/network protocol.md

Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Hussein Farran <hmfarran@gmail.com>

Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>
Co-authored-by: Hussein Farran <hmfarran@gmail.com>
 2022-07-29 01:11:52 +02:00
black-sliver 3c6bd555b4
doc: add style guide (#746) 
* doc: add style guide

* doc: style guide for python and markdown

* doc: consistent use of periods and explicit double quotes in style guide

Co-authored-by: Hussein Farran <hmfarran@gmail.com>

* doc: better define string style in style guide

* doc: add format string literals to style guide

* doc: add HTML, CSS and JS to style guide

Co-authored-by: Hussein Farran <hmfarran@gmail.com>
 2022-07-15 23:52:35 +02:00
Hussein Farran a49bcd618d
Dev Docs: Add SA2B and SC2 to network diagram (#719) 
* Add SA2B and SC2 to network diagram

* Remove jpg version of image.

* Fix png of image... Github web editor borked it

* Update network diagram.svg

* We're back to light mode, friends.

Use SVG and JPG that are valid and let you zoom in properly.
 2022-07-06 16:12:53 -04:00
Chris Wilson 1843618c99
Add stone theme to WebHost (#645) 
* Add stone theme

* Fix h2 color, change rogue-legacy to stone theme (approved by Phar)

* Add stone theme preview to world api.md

* Different stone theme preview to match other images
 2022-06-22 20:31:40 -04:00
black-sliver 47edc356ad
api.md update and rename (#676) 
* api.md: update for ItemClassification

* world api.md: rename from api.md
 2022-06-19 15:19:46 +02:00
Fabian Dill 247f674749
Network remove roominfo players (#661) 2022-06-17 03:34:50 +02:00
Fabian Dill d81dbbd951 CommonClient: revamp DataPackage handling 2022-06-17 03:22:20 +02:00
Fabian Dill 83dee9d667 MultiServer: introduce LocationScouts create_as_hint -> only_new 2022-06-17 03:21:33 +02:00
black-sliver d31c24bbf7 Doc: deprecate datapackage_version 2022-05-30 09:52:12 +02:00
Fabian Dill e8be80ccd7 Network: remove "SlotAlreadyTaken" from docs and clients, as it was removed from the server in 0.2 2022-05-24 19:16:53 -07:00
alwaysintreble 45bca78e75 docs: add tutorials to api documentation 2022-05-18 21:29:59 +02:00
black-sliver 9e15e754c2 Doc: use RegionType.Generic in api.md 2022-05-11 11:53:57 +02:00
black-sliver a020dea277 Doc: fix wrong naming in api.md example code 2022-05-10 16:52:41 +02:00
Hussein Farran 1e592b4681
Update network protocol doc to extend intra-doc linking (#489) 2022-05-06 10:01:43 -04:00
Fabian Dill 5eab07d8d6
Network: add games argument to GetDataPackage (#473) 2022-04-30 04:39:08 +02:00
espeon65536 894a30b9bd
Check for ROMs at beginning of generation (#475) 2022-04-30 03:37:28 +02:00
beauxq 46d31c3ee3 typing, mostly in AutoWorld.py 
includes a bugfix (that was found by static type checking)
in `get_filler_item_name`
 2022-04-29 03:00:39 +02:00
NewSoupVi 3e8c821c02
Add The Witness (#467) 
* Added The Witness


Co-authored-by: metzner <unconfigured@null.spigotmc.org>
Co-authored-by: Jarno Westhof <jarnowesthof@gmail.com>
Co-authored-by: black-sliver <59490463+black-sliver@users.noreply.github.com>
 2022-04-29 00:42:11 +02:00
Hussein Farran 81feb2fd5e
[Docs] Update network diagram into mermaid diagram syntax. (#446) 2022-04-24 11:20:14 -04:00
KonoTyran 1fe82b1312
Add bug report link to WebWorld (#440) 
* Add bug report link to WebWorld

* change bug_report_page to an optional
reword bug report link text.

* update Minecraft bug report page to a template.

* change wording of link.

* add `bug_report_page` documentation to api.md
 2022-04-12 17:37:05 -04:00
black-sliver 42fecc7491
Core: change how required versions work, deprecate IgnoreGame (#426) 
`AutoWorld.World`s can set required_server_version and required_client_version properties. Drop `get_required_client_version()`.
`MultiServer` will set an absolute minimum client version based on its capability (protocol level).
`IgnoreVersion` tag is replaced by using `Tracker` or `TextOnly` with empty or null `game`.
Ignoring game will also ignore game's required_client_version (and fall back to server capability).
 2022-04-08 11:16:36 +02:00
Jarno Westhof 6f5ab05345
[Docs] Added WebWorld Theme (#387) 2022-04-01 22:39:39 +02:00
Jarno Westhof aab477b874 Value is not actually a member of a Set package 2022-03-31 20:16:04 +02:00
alwaysintreble 87a8e6e20c
Documentation: minor updates (#320) 
* documentation: add links to other guides in adding games.md

* documentation: add webworld to api.md

* documentation: point people to docs folder and discord for help with adding games

* tutorial: go a bit more in depth on downloading a template yaml

* Make Ijwu happy

* point to baseclasses.py in api.md and reformat links a bit
 2022-03-24 09:21:08 -04:00
black-sliver a6b22d1f41
Doc: rewrite patch section (#336) 
this gets rid of a lot of information that is not required
and somewhat adds best practice to it
 2022-03-23 19:47:27 -04:00
Jarno Westhof 8599506497
[Docs] Datastorage (#333) 2022-03-23 22:20:55 +01:00
black-sliver 5eccb0ed49
api.md: clarify get_required_client_version (#334) 2022-03-22 21:22:58 -04:00
Fabian Dill 840e634161 update docs with NetworkSlot and create_as_hint 2022-02-18 18:54:26 +01:00
Jarno Westhof 6d704eadd7 [Docs] Added reference to the cpp lib 2022-02-16 13:05:47 +01:00
black-sliver a4eea3325f Document id range for items and locations 2022-02-12 03:00:09 +01:00
black-sliver 29ba1d4809 Doc: change displayname to display_name in api.md 2022-02-02 23:38:00 +01:00
Jarno 6def1bce25 [Docs] Made LocationInfoPacket more specific 2022-01-31 18:55:20 +01:00
Jarno Westhof 3ab5c90d7c [Docs] updated description on player property of NetworkItem 2022-01-31 18:55:20 +01:00
Jarno Westhof ddd3073132 [Docs] Fixed typo 2022-01-30 13:52:51 +01:00
Jarno Westhof 2694bd37ea [Docs] Extended info about bounced packets 2022-01-26 23:29:18 +01:00
black-sliver f0cfe30a36
Move remote_items and _start_inventory from world to client (#227) 2022-01-23 06:38:46 +01:00
black-sliver 0c46cc6843 Add per-client remote_item settings + TextOnly Tag 
* Tracker tag will receive all items via server (including local)
* TextOnly tag will receive no items
* TextClient sends TextOnly tag
* precollected items / start_inventory does not get an "Order received" number anymore
* local items do always get an "Order received" number now
* multisave changed, includes version number now, upgrade works for games (not trackers)
 2022-01-21 22:42:59 +01:00
Jarno Westhof 5df4d2f2fd
[Docs] Specified NetworkItem player is about the player slot of the location, not who the item is intended for (#217) 2022-01-18 19:01:51 +01:00
Fabian Dill b82e0749b7 Network Docs: should put the bits in the right spot 2022-01-18 06:51:16 +01:00
Fabian Dill 5c1d2b3393 Network: unify flags docs and implementation 2022-01-18 06:45:09 +01:00
Jarno Westhof c9fa49d40f
[Network_Item] Add item flags to network item so client can distinct some details (#210) 2022-01-18 05:52:29 +01:00
Jarno Westhof a5d2046a87
[Docs] More Links (#179) 
* [Docs] More Links

* [Docs] Moved link for data package object
 2022-01-01 20:29:38 +01:00
Jarno Westhof 4db4b5305e
[Docs] Added links to client implementations (#167) 2021-12-31 20:05:36 +01:00
Fabian Dill 49a0f473ce Docs: add more explanation to text type of JSONMessagePart 2021-11-30 08:25:22 +01:00
Fabian Dill 520e5feefb Docs: add missed JSONMessagePart types 2021-11-30 06:41:50 +01:00
Fabian Dill c381df6563 MultiServer: filter new locations via sets, instead of if and only echo new checks 2021-11-23 20:16:48 +01:00
CaitSith2 6b4445e122 move webhost configuration sample yaml to docs 2021-11-17 23:39:21 -08:00
Fabian Dill 82d3e4bc92 Docs: document "Archipelago" special IDs 2021-11-11 11:48:09 +01:00