okeyground

1.0.14 • Public • Published

TODO

  • add open group by drag
  • add move dests
  • notify move guide
  • animation

    • add draw left animation
    • add force animations
    • add open series animation
    • add leave-taken
    • add collect open animation
    • add drop open animation
    • spectator/opponent
      • add draw middle
      • add discard
      • add leave-taken
      • add open-series
    • add leave taken api
    • draw middle flip animation wait on board

BUG

  • draw left animation fail if no discard piece
  • self leave taken/collect open
  • allow drag group not left collide itself - [ ] fix force vs user move collisions not here - [ ] fix group rainbow with fake color collision not a bug
  • canDropOpens checks for both dop dos
  • slide pieces to make room / not replace
  • dont allow piece collision
  • remove wood dom, less width

Formatting

Piece

piece = color + number
number = 1-13
color = r|g|b|l
r = red
g = green
b = blue
l = black

example: r1 b13 g5

Board

16 x 2 dimensions

board = [piece|\s]{32}

example: r1b13g5 r1b13g5g5 g1

Discard

every direction discards to its right side. so up discards top left, down discards bottom right.

discard = [piece|\s]{4}

represents: [up, left, down, right]

example: r13b1l1

Middle

middle = middleCount + gosterge
gosterge = piece
middleCount = \d

example: 20r10

Opens

Opened series appear on the left side Opened pairs appear on the right side

opens = series/pairs
pairs = series = [piece|\s]

each piece group is separated by a \s

example: r13b1l1 r2b2l2 r1r2r3r4r5/r1r1 g2g2 l2l2

Drop Opens

drop open series = dos (piece) pos drop open pairs = dop (piece) pos

pos = append type + group index

append type = l|r|p

append left = l append right = r replace okey = p

example: l1 r0 p2

FEN

~~ fen = board/discard/series/pairs/middle/povSide ~~

fen = povSide/middle/board/discard/openSeries/openPairs

Rules

move pieces on board draw middle draw left discard discard end show sign drop open series drop open pairs

Moves

draw middle draw left discard discard end

api move (key, piece) turnSide == player

player

draw left / discard user move place on board api move noop

draw middle user move add middle placeholder api move (piece) replace placeholder

opponent draw middle / draw left / discard api move do move

API

// reconfigure the instance. Accepts all options mentioned above.
ground.set(options);

// make a move for turn side.
// dm | dl | dd | lt | dop | dos
ground.apiMove(move, piece);

// provide the drawn middle piece, required to end the draw middle progress.
ground.apiDrawMiddleEnd(piece)

Getters

// get piece groups on board
var pieceGroups = ground.getPieceGroups();

Readme

Keywords

none

Package Sidebar

Install

npm i okeyground

Weekly Downloads

0

Version

1.0.14

License

MIT

Unpacked Size

648 kB

Total Files

89

Last publish

Collaborators

  • eguneys