@hrejko/client

React client library for the Hrejko multiplayer game framework. Provides React components and hooks for connecting to Hrejko game servers.

Installation

npm install @hrejko/client

Peer dependencies: React 19+

What's Included

• HrejkoProvider — React context provider for game state
• useHrejko — Hook for accessing game state and sending actions
• CanvasProvider / CanvasSurface / useCanvas — Canvas rendering system
• Joystick / ActionButton / MobileControls — Mobile touch controls

Quick Start

import { HrejkoProvider, useHrejko } from "@hrejko/client";

function App() {
  return (
    <HrejkoProvider url="ws://localhost:8080">
      <Game />
    </HrejkoProvider>
  );
}

Related Packages

• @hrejko/shared — Shared types and utilities
• @hrejko/core — Core utilities and base classes
• @hrejko/server — Server-side game engine

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type-aware lint rules:

export default tseslint.config({
  extends: [
    // Remove ...tseslint.configs.recommended and replace with this
    ...tseslint.configs.recommendedTypeChecked,
    // Alternatively, use this for stricter rules
    ...tseslint.configs.strictTypeChecked,
    // Optionally, add this for stylistic rules
    ...tseslint.configs.stylisticTypeChecked,
  ],
  languageOptions: {
    // other options...
    parserOptions: {
      project: ["./tsconfig.node.json", "./tsconfig.app.json"],
      tsconfigRootDir: import.meta.dirname,
    },
  },
});

You can also install eslint-plugin-react-x and eslint-plugin-react-dom for React-specific lint rules:

// eslint.config.js
import reactX from "eslint-plugin-react-x";
import reactDom from "eslint-plugin-react-dom";

export default tseslint.config({
  plugins: {
    // Add the react-x and react-dom plugins
    "react-x": reactX,
    "react-dom": reactDom,
  },
  rules: {
    // other rules...
    // Enable its recommended typescript rules
    ...reactX.configs["recommended-typescript"].rules,
    ...reactDom.configs.recommended.rules,
  },
});