45bca78e75
docs: add tutorials to api documentation
2022-05-18 21:29:59 +02:00
9e15e754c2
Doc: use RegionType.Generic in api.md
2022-05-11 11:53:57 +02:00
a020dea277
Doc: fix wrong naming in api.md example code
2022-05-10 16:52:41 +02:00
1e592b4681
Update network protocol doc to extend intra-doc linking ( #489 )
2022-05-06 10:01:43 -04:00
5eab07d8d6
Network: add games argument to GetDataPackage ( #473 )
2022-04-30 04:39:08 +02:00
894a30b9bd
Check for ROMs at beginning of generation ( #475 )
2022-04-30 03:37:28 +02:00
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
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
81feb2fd5e
[Docs] Update network diagram into mermaid diagram syntax. ( #446 )
2022-04-24 11:20:14 -04:00
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
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
6f5ab05345
[Docs] Added WebWorld Theme ( #387 )
2022-04-01 22:39:39 +02:00
aab477b874
Value is not actually a member of a Set package
2022-03-31 20:16:04 +02:00
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
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
8599506497
[Docs] Datastorage ( #333 )
2022-03-23 22:20:55 +01:00
5eccb0ed49
api.md: clarify get_required_client_version ( #334 )
2022-03-22 21:22:58 -04:00
840e634161
update docs with NetworkSlot and create_as_hint
2022-02-18 18:54:26 +01:00
6d704eadd7
[Docs] Added reference to the cpp lib
2022-02-16 13:05:47 +01:00
a4eea3325f
Document id range for items and locations
2022-02-12 03:00:09 +01:00
29ba1d4809
Doc: change displayname to display_name in api.md
2022-02-02 23:38:00 +01:00
6def1bce25
[Docs] Made LocationInfoPacket more specific
2022-01-31 18:55:20 +01:00
3ab5c90d7c
[Docs] updated description on player property of NetworkItem
2022-01-31 18:55:20 +01:00
ddd3073132
[Docs] Fixed typo
2022-01-30 13:52:51 +01:00
2694bd37ea
[Docs] Extended info about bounced packets
2022-01-26 23:29:18 +01:00
f0cfe30a36
Move remote_items and _start_inventory from world to client ( #227 )
2022-01-23 06:38:46 +01:00
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
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
b82e0749b7
Network Docs: should put the bits in the right spot
2022-01-18 06:51:16 +01:00
5c1d2b3393
Network: unify flags docs and implementation
2022-01-18 06:45:09 +01:00
c9fa49d40f
[Network_Item] Add item flags to network item so client can distinct some details ( #210 )
2022-01-18 05:52:29 +01:00
a5d2046a87
[Docs] More Links ( #179 )
...
* [Docs] More Links
* [Docs] Moved link for data package object
2022-01-01 20:29:38 +01:00
4db4b5305e
[Docs] Added links to client implementations ( #167 )
2021-12-31 20:05:36 +01:00
49a0f473ce
Docs: add more explanation to text type of JSONMessagePart
2021-11-30 08:25:22 +01:00
520e5feefb
Docs: add missed JSONMessagePart types
2021-11-30 06:41:50 +01:00
c381df6563
MultiServer: filter new locations via sets, instead of if and only echo new checks
2021-11-23 20:16:48 +01:00
6b4445e122
move webhost configuration sample yaml to docs
2021-11-17 23:39:21 -08:00
82d3e4bc92
Docs: document "Archipelago" special IDs
2021-11-11 11:48:09 +01:00
987bbc761a
Add `found` to `PrintJSON` packet.
2021-11-08 13:10:17 -05:00
beb15aa99a
Update network protocol.md
2021-11-08 12:48:17 -05:00
ca9bf48ffa
Network: document ConnectUpdate
2021-11-08 16:58:41 +01:00
e8639988ce
MultiServer: original_cmd to InvalidPacket
2021-11-08 16:07:37 +01:00
666e3b5333
MultiServer: add JSONMessagePart["player"]
2021-11-07 14:42:05 +01:00
2b124aaff4
MultiServer: add time to RoomInfo
2021-11-07 11:37:58 +01:00
e756a77c70
MultiServer: implement Tracker tag
...
Docs: add InvalidPacket
Docs: add known Tags
Docs: add DeathLink
LttPClient: potentially fix DeathLink chaining
2021-11-04 13:23:13 +01:00
c9a3f67121
Update network protocol.md
2021-10-22 19:57:32 -04:00
8e35372aad
Network: add RoomInfo -> Games
...
Allows clients to only download relevant parts of the datapackage, or to keep ID lookups per-game, and for Bounce to tell if there will be a receiving end.
2021-10-22 04:46:00 +02:00
192e592cda
Docs: coop
2021-10-21 23:07:39 +02:00
2f5bdc5cf9
Merge pull request #98 from black-sliver/doc-update
...
add world api documentation
2021-10-20 19:41:39 -04:00
34eba2655e
MultiServer: add !collect and collect_mode
...
CommonClient: make missing and checked location lookups faster
FactorioClient: implement reverse grant technologies for collect/forfeit/coop
2021-10-18 22:58:29 +02:00
alwaysintreble
black-sliver
Hussein Farran
Fabian Dill
espeon65536
beauxq
NewSoupVi
KonoTyran
Jarno Westhof
Fabian Dill
Jarno
CaitSith2