mirror of
https://github.com/MarioSpore/Grinch-AP.git
synced 2025-10-21 20:21:32 -06:00
api.md: Apply second batch of suggestions from code review
Co-authored-by: Hussein Farran <hmfarran@gmail.com>
This commit is contained in:
12
docs/api.md
12
docs/api.md
@@ -5,8 +5,10 @@ Archipelago's generation and server. Once a seed is generated, a client or mod i
|
|||||||
required to send and receive items between the game and server.
|
required to send and receive items between the game and server.
|
||||||
|
|
||||||
Client implementation is out of scope of this document. Please refer to an
|
Client implementation is out of scope of this document. Please refer to an
|
||||||
existing game that provides a similar API to yours or read the
|
existing game that provides a similar API to yours.
|
||||||
[network protocol.md](https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/network%20protocol.md)
|
Refer to the following documents as well:
|
||||||
|
* [network protocol.md](https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/network%20protocol.md)
|
||||||
|
* [adding games.md](https://github.com/ArchipelagoMW/Archipelago/blob/main/docs/adding%20games.md)
|
||||||
|
|
||||||
Archipelago will be abbreviated as "AP" from now on.
|
Archipelago will be abbreviated as "AP" from now on.
|
||||||
|
|
||||||
@@ -142,12 +144,6 @@ on the the current `state` (items that can be collected).
|
|||||||
An item rule is a function that returns `True` or `False` for a `Location` based
|
An item rule is a function that returns `True` or `False` for a `Location` based
|
||||||
on a single item. It can be used to reject placement of an item there.
|
on a single item. It can be used to reject placement of an item there.
|
||||||
|
|
||||||
### Plando
|
|
||||||
|
|
||||||
Plando allows a player to place certain items in certain locations through their
|
|
||||||
player options. While specifics are not covered here, plando is automatically
|
|
||||||
possible by providing a complete world with a working create_item method.
|
|
||||||
|
|
||||||
|
|
||||||
## Implementation
|
## Implementation
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user