Installation

Prerequisites

• Node.js 18 or later
• An Electron project (v18.0.3 or later)
• TypeScript (recommended)

Install the Package

npm install @marshallofsound/ipc

Or with yarn:

yarn add @marshallofsound/ipc

Project Structure

EIPC works best with a structured project layout:

my-electron-app/
├── src/
│   ├── main/           # Main process code
│   ├── preload/        # Preload scripts
│   ├── renderer/       # Renderer process code
│   └── schema/         # Your .eipc schema files
│       └── api.eipc
│   └── ipc/            # Generated code (auto-created)
│       ├── browser/
│       ├── preload/
│       ├── renderer/
│       └── ...
└── package.json

TypeScript Configuration

Ensure your tsconfig.json includes the generated IPC directory:

{
  "compilerOptions": {
  "module": "ESNext",
  "moduleResolution": "bundler",
  "esModuleInterop": true,
  "strict": true
  },
  "include": ["src/**/*"]
}

Build Integration

Add the generate-ipc CLI to your build scripts:

{
  "scripts": {
    "generate:ipc": "generate-ipc src/schema src/ipc",
    "build": "npm run generate:ipc && your-build-command"
  }
}

The CLI takes two arguments:

• src/schema — Directory containing your .eipc schema files
• ipc — Output directory for generated code

Electron Forge Integration

If using Electron Forge, add generation to your forge.config.js:

module.exports = {
  hooks: {
    generateAssets: async () => {
      const { generateWiring } = await import('@marshallofsound/ipc');
      await generateWiring({
        schemaFolder: './src/schema',
        wiringFolder: './src/ipc',
      });
    },
  },
};

Next Steps

Now that EIPC is installed, continue to the Quick Start guide to create your first schema.