RanvierMUD / docs

3 stars 4 forks source link

Document currency implementation #8

Open seanohue opened 5 years ago

seanohue commented 5 years ago

This is another default/example implementation that seems to exist across multiple bundles and may be worth documenting.

shawncplus commented 5 years ago

I've been thinking a lot about how a "patterns" sections would work. i.e., things that aren't actually features of core but are essentially what someone would inevitably come up with when trying to implement something in Ranvier. For example: currency implemented as player metadata.

The question is at what point does a pattern guide just become a bundle with docs?

seanohue commented 5 years ago

Good question. I think a patterns/recipes section to the docs would be very helpful, and since people tend to look there first rather than bundle READMEs, it should definitely be on the docs site IMO. Having each recipe refer to an actual bundles code would be ideal as well.

shawncplus commented 5 years ago

I agree. I think it ends up being 4 tiers of problem solving:

  1. bare bones (fully DIY)
  2. Patterns (DIY + following "best practices")
  3. Bundles (Use a already-implemented bundle)
  4. Codebases (ranvier-tiny, ranvier-trpg, ranviermud) Start with a project that already implements 85% of what you want and go from there

All 4 should be present in the docs. I think 1 and 3 are covered to some extent (2 gets some love in a couple pages but not really) and 4 isn't covered at all. All 4 paradigms should be present in the docs