Commit Graph

21 Commits

Author SHA1 Message Date
Guangcong Luo
f1d95979e7 Slightly improve documentation 2021-11-13 14:17:47 -05:00
Guangcong Luo
ea8e9df4e6 Further improve documentation 2021-06-10 09:17:58 -07:00
Guangcong Luo
a813a55679 Document changes and Dex
With Dex now having basic documentation, all our API documentation is
now inter-linked.
2021-06-09 17:51:49 -05:00
Guangcong Luo
46ad7ad716 Add some basic documentation on team formats 2021-03-30 18:47:02 -07:00
Guangcong Luo
c96b2d6248 Improve sim readme 2020-10-24 22:09:52 +01:00
Guangcong Luo
ebd1ed11e4 Fix typo in sim/README.md 2020-10-21 17:32:10 +01:00
Guangcong Luo
2faa3d635d Publish 0.11.3 to npm
PS's sim engine is now available on npm!

sim/README.md describes how to use it:

https://github.com/smogon/pokemon-showdown/blob/master/sim/README.md
2020-10-21 17:24:58 +01:00
Guangcong Luo
18948c8c2c Refactor ObjectReadStreams to use for-await
Regular ReadStreams still can't; I now believe they shouldn't have a
"default" read method, and you should explicitly choose whether you
want to read "by chunks as they become available", "by chunks of a
specific line" or "by a delimiter".

So you would specifically use `stream.byLine()` or
`stream.byChunk([size])`, which would return an
`ObjectReadStream<string>`.

Inspired by #7195
2020-08-15 15:11:53 -07:00
Spandan Punwatkar
b6b66de896 Update Repo Links (#6102) 2019-11-28 12:47:38 +04:00
Kirk Scheibelhut
7e4929a39f Change protocol for '|split' message type (#5331) (#5332) 2019-04-22 09:20:47 +09:30
MacChaeger
6ac8266696 Support 4 player battles (#5266) 2019-03-18 13:37:27 +09: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
Guangcong Luo
bcefeb2925
Fix other typo in Sim Readme 2018-09-17 20:28:50 -05:00
Guangcong Luo
50324e5800
Fix typo in Sim Readme 2018-09-17 20:24:09 -05:00
Guangcong Luo
0f2d590e6e
Update SIM README MOVESLOTSPEC table 2018-09-03 21:12:45 -05:00
Guangcong Luo
a96e804c87
Improve Sim README
- Remove reference to "new API" vs "old API"
- Fix `TARGETSPEC` table Markdown
2018-09-03 21:09:28 -05:00
Guangcong Luo
925706083e
Sim readme: Fix choice spec 2018-04-06 14:15:07 -05:00
Guangcong Luo
d9bf6742ff
Sim readme: Improve stream-consuming example code 2018-03-02 03:13:59 +09:00
Guangcong Luo
b58e08e215 Improve Sim documentation 2018-01-28 22:04:41 -06:00
Guangcong Luo
4af43bd698 Document choice specifications 2018-01-28 21:56:37 -06:00
Guangcong Luo
1c62891008 Document new Sim API 2018-01-28 21:23:06 -06:00