[!TIP] This documentation is available in English & Japanese このドキュメントは英語版と日本語版があります。

🚄 About the Name

Kumoha is a Japanese railway classification prefix used to designate an electric multiple unit (EMU) car that is both motorized and equipped with a driving cab. The name is composed of:

• Ku (ク): indicating a control (driving) cab is present,
• Mo (モ): indicating that the car has traction motors,
• Ha (ハ): indicating a passenger car.

📦 Installation

This package is published as @tanuden/kumoha.

npm install @tanuden/kumoha

• Works on both frontend and backend environments
• For React users, it's recommended to use @tanuden/kumoha-react and consume the hooks it provides

📚 Basic Usage

import { Kumoha } from '@tanuden/kumoha';

const engine = Kumoha("ws://localhost:58680", {
  socketOptions: {
    // socket.io options (not recommended to modify unless necessary)
  }
});

// Example login with room ID "ABC123" -- Refer to the Tanuden Console for the room ID
await engine.login('ABC123');

// Example button action sending "DoorOpn" (door open)
await engine.sendButtonAction('DoorOpn', true);

• The port number in the URI (58680) is fixed by the Tanuden Console and should not be changed.
• Modifying socketOptions is generally not recommended unless you have specific advanced use cases.

🎛️ Supported Button Actions

The sendButtonAction method accepts action strings matching the Train Crew Controller API. Below is a list of common actions and their descriptions.

| Action | Description | | ---------- | -------------------------- | | NotchUp | Increase throttle step | | NotchDw | Decrease throttle step | | NotchN | Set throttle to Neutral | | NotchEB | EB notch (emergency brake) | | Buzzer | Buzzer | | HornAir | Air horn | | HornEle | Electric horn | | ViewChange | Change viewpoint | | PauseMenu | Pause menu | | DoorOpn | Open door | | DoorCls | Close door | | Housou | Announce (PA system) |

For the full list and detailed descriptions, please refer to Train Crew Controller API documentation.

💾 Tanuden OSS

This project is licensed under the GNU Lesser General Public License v2.1 (LGPL-2.1). For more details, please see the LICENSE file.

[!IMPORTANT] This repository may contain trademarks or logos owned by Tanukigawa Railway. Unauthorized use is prohibited.

💝 Support

If you have some spare change you'll like to contribute to my ramen fund (helps keep me filled while working on projects), visit my Fanbox.

Tanuden Discord Server | Twitter | YouTube

Tanukigawa Electric Railway | Copyright © 2025 Haruyuki Tanukiji.