Unable to easily add custom formats #28
Labels
bug
Something isn't working
Comments
scheibo
added a commit
that referenced
this issue
Mar 11, 2024
documentation and unit testing are still necessary, though this should mostly handle #21 and #28 once published. This isn't very pretty: - FormatList is kind of impossible to type correctly with access to @pkmn/sim, but @pkmn/mods cant really depend on @pkmn/sim. I am fine just punting with `any` - I don't know what the consequences are (other than performance) of making modded dexes build their own formatsListCache. I can't see any obvious issue this might cause, but its entirely possible its going to fuck something up - The corresponding mod rulesets should really be in the mods' rulesets.ts files instead of in the main rulesets, but this is really awkward to accomplish (lots of ugly code to add to `import`) so we're punting on this as well Not a feel good change, but crudely patches an otherwise pretty obnoxious hole in the API
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Users get confused when formats are missing as the documentation does not make clear that
@pkmn/simcontains a different set of configured formats than upstream Pokémon Showdown by design. Documentation should call this out, explain thatconfig/formats.tsis in fact configuration that depends on arbitrary project preferences and thus something you can not always depend on, and also show how to easily augment the default formats with ones preferred formats (or those formats which are present on https://github.com/smogon/pokemon-showdown).Sadly, this last part is not working as intended today due to some intersection of #21 and #25, so really all three of the issues will probably get addressed at the same time.
The text was updated successfully, but these errors were encountered: