2d5ec6ce22
Doc: item/location name must not be numeric
2022-09-20 18:38:16 +02:00
a95d0ce9ef
Doc: clarify requirements.txt in world api.md
2022-09-20 09:48:30 +02:00
1c0a93acad
doc: update use of relative/absolute imports
...
it matters for apworlds to function
2022-09-18 10:22:17 +02:00
af11fa5150
Core: auto alias ( #1022 )
...
* Test: check that default templates can be parsed into Option objects
2022-09-16 00:32:30 +02:00
b115bdafe7
CI/Doc: Use pytest subtests ( #986 )
...
* CI/Doc: use pytest-subtests
* CI: clean up pip installs a bit
* make lint and unittests install the same stuff
* make sure to install wheel, which is a recommended (not required) dependency for everything pip
2022-09-01 09:30:28 +02:00
a78863fde1
Docs: Update community supported libraries in api doc ( #788 )
...
* Docs: Update client supported libraries in api doc
* left align table column
* Update table of languages to include Haxe lib and remarks
* Reformat table
* Changed verbiage on SNI remark
2022-08-26 02:12:37 -05:00
0a5b24be2b
[Core] Phase out Print packets and added Countdown type to print json ( #812 )
...
* [Core] Added Countdown type to print json to distinct the count down message from other types
* Added backward compatibility check
* Fixed review comments
* Updated header category
* Apply suggestions from code review
Co-authored-by: Hussein Farran <hmfarran@gmail.com>
* Completely phased out Print in favor of PrintJson
* Updated docs to warn about phasing out of Print
* Removed faulty import
Co-authored-by: Hussein Farran <hmfarran@gmail.com>
2022-08-23 01:02:10 +02:00
d66f981be6
Github: templates and new user interface ( #870 )
...
* move some docs out of readme and link with the headers
* PR template
* bug report template
* task and feature request templates
* md cleanup
* forgot the template
* make expected results separate section
* move pr template to .github. remove assignment field on tasks
* add headers to pr template
* Requested changes
* suggested changes from @black-sliver and @SoldierofOrder
* Update docs/code_of_conduct.md
Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>
* Update docs/contributing.md
Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>
* Update docs/contributing.md
Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>
Co-authored-by: Hussein Farran <hmfarran@gmail.com>
Co-authored-by: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com>
2022-08-23 00:39:55 +02:00
086295adbb
AutoWorld: add preliminary .apworld specification ( #903 )
...
* AutoWorld: add preliminary .apworld specification
* Doc: apworld specification: fix typo
2022-08-15 23:47:32 +02:00
81cf1508e0
Core: Refactor Autoworld.options to Autoworld.option_definitions ( #906 )
...
* refactor `world.options` -> `world.option_definitions`
* rename world api reference
* missed some self.options
2022-08-15 23:46:59 +02:00
97b388747a
Docs: Added DS3 & DK3 to network graph
2022-08-15 16:56:55 +02:00
dd6e212519
[Core] Colorama fix
2022-08-05 17:17:40 +02:00
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
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
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
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
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
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
247f674749
Network remove roominfo players ( #661 )
2022-06-17 03:34:50 +02:00
d81dbbd951
CommonClient: revamp DataPackage handling
2022-06-17 03:22:20 +02:00
83dee9d667
MultiServer: introduce LocationScouts create_as_hint -> only_new
2022-06-17 03:21:33 +02:00
d31c24bbf7
Doc: deprecate datapackage_version
2022-05-30 09:52:12 +02:00
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
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
d79acef59e
api.md: update precollected for commit# e66a2a7
2021-10-10 18:39:03 +02:00
2f04b93fdb
api.md: add set Location.event in location skeleton
2021-10-10 14:03:33 +02:00
818e99b39d
api.md: add exclusions to create_items, fix bug in generate_output
2021-10-10 13:09:18 +02:00
ba13d2179d
Slightly improved docs about permissions flags
2021-10-09 13:58:07 +00:00
652c9943c2
api.md: add to the list of requirements
2021-10-09 14:35:08 +02:00
9f62575abe
api.md: add data_version, clarify ids, add precollected_items
2021-10-09 14:29:52 +02:00
2fd87f703e
api.md: fix more stuff based on comments
2021-10-09 13:00:50 +02:00
0376705e47
api.md: change 'Your World' based on suggestions
2021-10-09 11:28:15 +02:00
f1fddac655
api.md: add item groups, fix typo, reformat long lines
2021-10-09 11:06:41 +02:00
317f7116c4
api.md: Reword some things based on @Ijwu's suggestions
2021-10-09 02:05:55 +02:00
bf8e99140e
api.md: Apply second batch of suggestions from code review
...
Co-authored-by: Hussein Farran <hmfarran@gmail.com>
2021-10-09 01:15:35 +02:00
6c949c3a52
api.md: Apply first batch of suggestions from code review
...
Co-authored-by: Hussein Farran <hmfarran@gmail.com>
2021-10-09 00:49:47 +02:00
76d591bab5
Update adding games.md
2021-10-08 17:20:05 -04:00
87ceef230f
api.md: remove useless \s, fix mixin example
2021-10-08 00:39:16 +02:00
a06e81a0ba
api.md: add logic and output, fixed some typos, added some typos
2021-10-08 00:25:31 +02:00
59e87e0d27
api.md: fix Item.advancement description
2021-10-07 19:53:19 +02:00
76d1460d0f
add api.md work-in-progress v3
2021-10-07 19:41:29 +02:00
29a207b73e
Docs: update networkgraph
2021-10-06 10:46:42 +02:00
f7ecf02beb
Added timespinner to graphml
2021-10-06 08:39:39 +00:00
cff5db446d
Fixed some bugs + added documentation + added a few features ( #87 )
...
* Refactorings + minor logic fix
* Fixed unnececerly recalculation of item_name_groups
* Enabled other itemId's so that they can be send to client when desired
* Marked the loss of location 1337158
* Updated network graph
* First draft tinmespinner documentation
* Moved personal items to slot_data rather than location scouts
* Disabled Remote Items
* Updated docs
* Fixed port override
2021-09-30 19:51:07 +02:00
345d4c58f3
Network: Add docs for new permissions mapping and implement it in CommonClient.py
2021-09-28 17:22:23 +02:00
442b6ced35
Docs: Update network graph
2021-09-20 12:15:31 +02:00
b82e3f2a8a
MultiServer: Split InvalidSlot out into InvalidGame and document all error codes.
2021-09-17 04:32:09 +02:00
a1a7729c3b
Docs: point to existing further documentation.
2021-09-11 22:44:48 +02:00
bc47f78264
Remove colons in headings.
2021-09-08 13:46:31 -04:00
b002f7f862
Update document with relative images and links, as well as updated language and formatting.
2021-09-08 13:43:39 -04:00
242595b725
Added guide for adding new games to AP
2021-09-08 07:05:19 -07:00
black-sliver
Fabian Dill
Zach Parks
Jarno
alwaysintreble
Hussein Farran
Chris Wilson
Fabian Dill
espeon65536
beauxq
NewSoupVi
KonoTyran
Jarno
CaitSith2
SolventMercury