Skip to content
Shoehive
Search
Ctrl
K
Cancel
GitHub
Select theme
Dark
Light
Auto
Menu
Start
Why Shoehive
Quick start
The six concepts
Tutorials
Tic-tac-toe in 20 minutes
Quiz: round-based play
Blackjack: hidden cards, phases, turn timers, chips
Texas Hold'em: private hands and side pots
How-to
Authentication (guest and custom)
Reconnects and sessions
Hidden information
Timers and turn clocks
Turns vs rounds
Phases
Persistence and restart recovery
Writing a store adapter
Wallets and real-money safety
Spectators
Testing games
Debugging with devtools and time travel
Deploying (single node, Docker, behind a proxy)
Logging and metrics
Concepts
Tables and seats
Actions, drafts and atomicity
Turns and rounds
Views and sync (revisions, patches)
Determinism, replay and persistence
Security model
Reference
Config options
Error codes
Wire protocol
Stores
Devtools
Benchmarks
Changelog
API
shoehive
Namespaces
StandardSchemaV1
StandardSchemaV1
interfaces
FailureResult
Issue
PathSegment
Props
SuccessResult
Types
type-aliases
InferInput
InferOutput
Result
Classes
MemoryWallet
ReplayDivergenceError
ShoehiveError
TableRuntime
Interfaces
ActionArgs
ActionCtx
ActionDef
Clock
Commit
CtxRound
CtxTimers
CtxTurn
CtxWallet
Diagnostic
EmittedEvent
EngineSeat
EngineState
GameConfig
GameTypes
HookArgs
LobbyDocument
LobbyFilter
LobbyTable
LogEntryBase
PhaseDef
Random
ReadCtx
RoundInfo
RoundsConfig
RuntimeOptions
SeatInfo
Snapshot
StandardSchemaV1
TableDocument
TableMeta
TimerState
TurnArgs
TurnInfo
TurnsConfig
ViewArgs
Wallet
WalletFailure
WalletReservation
Welcome
WireError
Type Aliases
Ack
Amount
AnyGame
BuiltinErrorCode
ClientMessage
ClientPing
ClientRequest
EventAudience
Game
GameActions
GameErrorCode
GameId
GameOptions
GameOptionsInput
GamePhases
GameResult
GameState
GameView
Hook
Json
JsonPatchOp
LogEntry
ParseResult
RequestType
ReserveResult
ServerMessage
TableStatus
TimerHandle
Viewer
WalletEffect
WalletOp
Variables
BUILTIN_ERROR_CODES
CLOSE
PROTOCOL_VERSION
systemClock
Functions
applyPatch
defineGame
diff
isBuiltinErrorCode
isShoehiveError
parseClientMessage
reject
shoehive/cards
Interfaces
BlackjackValue
PokerHand
Pot
Type Aliases
Card
HandCategory
Rank
Suit
VisibleCard
Variables
HAND_CATEGORIES
RANKS
SUITS
Functions
awardPots
blackjackValue
cardName
compareHands
draw
evaluateHand
faceDown
hideCard
isCard
rankOf
rankValue
revealTo
seatView
shoe
splitPots
standardDeck
suitOf
winners
shoehive/client
Classes
LobbyHandle
ShoehiveClient
TableHandle
Interfaces
ActResult
ClientOptions
TokenStorage
WebSocketLike
Type Aliases
ActArgs
ConnectionStatus
GameById
TypedTableMeta
Variables
CLIENT_ERROR_CODES
Functions
createClient
References
isShoehiveError
LobbyDocument
LobbyFilter
ShoehiveError
TableDocument
Welcome
shoehive/devtools
Interfaces
DevConnection
DevGameInfo
DevResults
DevSession
DevTableDetail
DevTableSummary
DevView
DevWelcome
Type Aliases
DevClientMessage
DevRequest
DevRequestType
DevServerMessage
Variables
DEVTOOLS_CLOSE
DEVTOOLS_PROTOCOL
References
DevtoolsHandle
DevtoolsOption
Fixture
shoehive/react
Interfaces
UseTable
Type Aliases
ShoehiveProviderProps
Functions
ShoehiveProvider
useClient
useConnection
useLobby
useServerTime
useTable
useTableEvent
shoehive/server
Classes
StoreConflictError
Interfaces
Connection
DevtoolsHandle
Logger
MemorySocket
PlayerIdentity
ServerEvents
ServerLimits
ServerOptions
SessionRecord
ShoehiveServer
Store
StoredEntry
StoredSnapshot
TableInfo
UpgradeRequest
Type Aliases
AuthHook
DevtoolsOption
Variables
consoleLogger
silentLogger
Functions
createServer
References
Amount
memoryStore
MemoryWallet
ReserveResult
Wallet
WalletOp
WalletReservation
shoehive/store/memory
Functions
memoryStore
References
SessionRecord
Store
StoreConflictError
StoredEntry
StoredSnapshot
shoehive/store/postgres
Interfaces
PostgresSchemaOptions
PostgresStoreOptions
Type Aliases
PostgresPool
Functions
migratePostgres
postgresStore
References
SessionRecord
Store
StoreConflictError
StoredEntry
StoredSnapshot
shoehive/store/redis
Interfaces
RedisStoreOptions
Functions
redisStore
References
SessionRecord
Store
StoreConflictError
StoredEntry
StoredSnapshot
shoehive/store/sqlite
Interfaces
SqliteStoreBaseOptions
SqliteStoreDatabaseOptions
SqliteStoreFileOptions
Type Aliases
SqliteStoreOptions
Functions
sqliteStore
References
SessionRecord
Store
StoreConflictError
StoredEntry
StoredSnapshot
shoehive/testing
Classes
FakeClock
TestTable
Interfaces
ConformanceRunner
Fixture
RecordedEvent
StoreBackend
TestTableOptions
Type Aliases
StoreConformanceTarget
WalletFunds
Variables
FAKE_EPOCH
TEST_SEED
Functions
createTestTable
fixtureStateHash
replayFixture
runStoreConformance
runWalletConformance
Contributing
Architecture tour
Writing docs
Release process
ADRs
ADR index
Games as typed deterministic state machines
One `shoehive` package with subpath exports
Per-viewer views and JSON Patch sync
Standard Schema validation for inputs and options
Mutative drafts with atomic commit
Seeded RNG, recorded clock and exact replay
Wallet ledger semantics
Turns and rounds
Store interface, snapshot plus log, and restart recovery
Guest identity and resume tokens
Devtools security model
RFCs
RFC 0001: Shoehive v1, a ground-up rebuild
GitHub
Select theme
Dark
Light
Auto
API reference
Modules
Section titled “Modules”
shoehive
shoehive/cards
shoehive/client
shoehive/devtools
shoehive/react
shoehive/server
shoehive/store/memory
shoehive/store/postgres
shoehive/store/redis
shoehive/store/sqlite
shoehive/testing