Commit Graph

44 Commits

Author SHA1 Message Date
Sergio Garcia
fc23103de1
Fix random typos (#11020)
Some checks are pending
Node.js CI / build (18.x) (push) Waiting to run
2025-04-13 23:59:36 -07:00
Guangcong Luo
89b976fe70 Update PROTOCOL.md docs
Some checks are pending
Node.js CI / build (18.x) (push) Waiting to run
2025-04-08 21:32:50 -07:00
Sergio Garcia
a0a6fed454
Fix oversights in & to ~ migration (#10595)
* Fix oversights in & to ~ migration

* It was just a symbol
2024-10-06 10:07:03 -06:00
Guangcong Luo
27ddf0e6b0
PROTOCOL.md: New API! New API! 2023-03-26 15:26:18 -07:00
Nixola
c7c84049b5
Update wss URL in PROTOCOL.md (#8715)
The previously shown URL (https://sim.smogon.com/showdown/websocket), along with sim3.smogon.com or sim.psim.us, doesn't work, since it serves a certificate that's only valid for sim3.psim.us, which is also the default domain currently used by the client.
2022-04-30 12:55:38 -07:00
Guangcong Luo
8f87b6b84b Move packed team docs out of PROTOCOL.md
Packed team docs are now standardiszed in sim/TEAMS.md

(Also a bunch of smaller documentation improvements.)
2021-06-10 15:04:25 -07:00
Guangcong Luo
ea8e9df4e6 Further improve documentation 2021-06-10 09:17:58 -07:00
Mia
77023b02b6
Stop defaulting messages to Lobby in protocol (#8304) 2021-05-17 07:17:48 -07:00
Guangcong Luo
6495c84928 Document / messages in protocol 2021-05-16 12:28:29 -07:00
Guangcong Luo
13189fdb02
Update Dex API (#8181)
This is the change that renames:

- `Dex.getMove` -> `Dex.moves.get`
- `Dex.getAbility` -> `Dex.abilities.get`
- `Dex.getItem` -> `Dex.items.get`
- `Dex.getSpecies` -> `Dex.species.get`
- `Dex.getEffect` -> `Dex.conditions.get`
- `Dex.getNature` -> `Dex.natures.get`
- `Dex.getType` -> `Dex.types.get`
- `Dex.getFormat` -> `Dex.formats.get`

In addition, some other APIs have been updated:

- `getByID` methods have also been added to every other table.
- `Dex.moves.all()` now gets an array of all moves
  - Plus equivalent methods for `abilities`, `items`, `species`, `formats`, `natures`, `types`
  - Note: there's no `Dex.conditions.all()`
- new API: `Dex.stats` for naming/iterating stats
- `Dex.getEffectByID` -> `Dex.conditions.getByID`
- `Dex.getType` -> `Dex.types.get`
- `Dex.data.Formats` -> `Dex.data.Rulesets`
- `Dex.formats` -> now an array `Dex.formats.all()`
- `Dex.getRuleTable` -> `Dex.formats.getRuleTable`
- `Dex.validateFormat` -> `Dex.formats.validate`

Team functions have been split off into a new `sim/teams` package:

- `Dex.packTeam` -> `Teams.pack`
- `Dex.fastUnpackTeam` -> `Teams.unpack`
- `Dex.generateTeam` -> `Teams.generate`
- `Dex.stringifyTeam` -> `Teams.export`

`Teams.export` has also been rewritten to better match how it works in client.

This implements #8178
2021-04-08 03:00:37 -07:00
Guangcong Luo
1a1e53fc92 Improve documentation
Fixes #7602

Also adds some other stuff, perhaps most notably why we don't use
package-lock so you don't have to dig for 2e85de348f
2020-10-29 15:14:29 +00:00
Guangcong Luo
9664f139ee
Update PROTOCOL to recommend HTTPS 2020-08-31 06:43:53 -07:00
Majeur
2f851ee6d3
Added another example of client implementation (#7010)
Added Android-Unofficial-Showdown-Client as an example of ps client implementation. This might help people to understand Pokémon Showdown's protocol easily.
2020-07-16 23:13:52 -07:00
Guangcong Luo
120d040758
PROTOCOL.md: Document |notify| 2020-06-03 11:14:29 -07:00
Felix König
830b30a304
Fix unbalanced markdown in PROTOCOL.md (#6564) 2020-04-12 14:01:20 -07:00
Spandan Punwatkar
b6b66de896 Update Repo Links (#6102) 2019-11-28 12:47:38 +04:00
Guangcong Luo
1376cd1bea
Update packed team documentation for Natures 2019-10-30 18:07:48 +10:30
Ben Davies
d05aa0cd08 Update PROTOCOL.md WRT recent user status protocol changes (#5638) 2019-07-21 13:45:36 +02:00
whales
9147863403 Tournaments: Support replacing players (#5600) 2019-07-15 00:07:37 -05:00
Kirk Scheibelhut
e85ebf2bcc Include player count in |tournament|start and /tour getusers (#5581) 2019-07-03 15:56:07 -07:00
Bär Halberkamp
ed5d534224
Add an AFK timer and status messages (#5002) 2019-07-01 01:47:13 +02:00
Kirk Scheibelhut
e1356c055b Send blockpms and blockchallenges status in |updateuser| (#5422) 2019-04-08 01:43:12 +08:00
Ben Davies
167dce1ca6 Add PSBot to the bot list in PROTOCOL.md (#5069)
PSBot is a bot I'm working on that will specialize in easily
customizable responses to chat messages, so it fills a niche that the
other bots on the list don't fill.
2019-01-05 20:50:08 -06:00
Guangcong Luo
d90ac63f4f Improve protocol documentation
Battle protocol documentation, instead of being strewn between
`PROTOCOL.md` and `sim/README.md`, is now in `sim/SIM-PROTOCOL.md`.

Also added:

- documentation for how to do searches and challenges
- documentation for packed team format

Fixes #5005
2018-12-01 19:29:50 -06:00
Quinton Lee
4b0b051f7a PROTOCOL.md: Document |tournament| (#4917)
Fixes #4771
2018-10-19 03:42:07 -05:00
Guangcong Luo
89b05a76ce
PROTOCOL.md: Add details to |title| doc 2018-07-23 10:30:57 +09:00
Guangcong Luo
28407e6efd
PROTOCOL.md: Document |title| 2018-07-23 10:27:46 +09:00
Guangcong Luo
f3dbfbe685 Refactor Decision -> Action
"Decision" and "Choice" were always kind of unclear, so Decision is now
Action. It should now be a lot clearer.

Actions are also now strongly typed.
2017-12-02 11:34:55 -06:00
Guangcong Luo
e192dfd466
Further improve PROTOCOL.md 2017-10-30 02:40:38 -05:00
Guangcong Luo
8bb886f84d
Improve PROTOCOL.md 2017-10-30 02:29:03 -05:00
Insist
68061c3a6b PROTOCOL.md: Fix Markdown header style (#4066) 2017-10-18 05:15:51 -05:00
Nixola
d5e6c4cf8a Added link to another chatbot implementation (#3543) 2017-06-13 22:18:11 -05:00
panpawn
2e226bfb47 PROTOCOL: Document |uhtml| and |uhtmlchange| (#2656) 2016-07-30 15:41:31 -04:00
Guangcong Luo
f72742d1a5 Improve PROTOCOL: Fix team preview 2016-07-05 22:19:12 -05:00
Guangcong Luo
7fd9d07e1b Improve PROTOCOL.md
The previous descriptions of `|switch|` and `|-detailschange|` were wrong .

I also added some examples for `|-sidestart|` and `|-fieldstart|`.
2016-07-05 22:10:11 -05:00
Kevin Lau
0dc1579a02 Update documentation of -ability message protocol 2015-07-27 15:16:52 -07:00
Kevin Lau
2c4fbd9070 Update PROTOCOL.md to document [anim], move info on action tags
The info on action tags are now in the Major Actions section since the
|move protocol message uses them as well.
2015-07-15 14:30:17 -07:00
Guangcong Luo
d5c622b493 Update challstr protocol 2015-06-27 23:18:43 -04:00
Quite Quiet
5d3d62c6a3 Update PROTOCOL.md with more minor actions 2015-06-25 07:22:21 +02:00
Kevin Lau
e02e25289d PROTOCOL.md: Change bold headers to h6 within Battle Messages
This allows Battle Message subsections to be linked to directly.
2015-06-24 00:27:09 -07:00
SolarisFox
7ed407dfd3 standardize "Pokémon" in .md files 2015-06-09 17:21:23 -07:00
SolarisFox
8cafc187d0 Battle requests documentation 2015-06-09 13:34:01 -07:00
Kevin Lau
9a2e2eb4f7 Document the -center message 2015-05-20 23:14:26 -07:00
Guangcong Luo
1d8446f9b1 Rename protocol-doc.md -> PROTOCOL.md
This matches all the other documentation file names.
2015-04-24 23:52:27 -05:00