Custom Webpack config

import Tabs from "@theme/Tabs"; import TabItem from '@theme/TabItem';

Remotion ships with it's own Webpack configuration.

You can override it reducer-style by creating a function that takes the previous Webpack configuration and returns the the new one.

When rendering using the command line

In your remotion.config.ts file, you can call Config.Bundler.overrideWebpackConfig() from remotion.

remotion.config.ts
ts
import { Config } from "@remotion/cli/config";
 
Config.overrideWebpackConfig((currentConfiguration) => {
  return {
    ...currentConfiguration,
    module: {
      ...currentConfiguration.module,
      rules: [
        ...(currentConfiguration.module?.rules ?? []),
        // Add more loaders here
      ],
    },
  };
});

remotion.config.ts
ts
import { Config } from "@remotion/cli/config";
 
Config.overrideWebpackConfig((currentConfiguration) => {
  return {
    ...currentConfiguration,
    module: {
      ...currentConfiguration.module,
      rules: [
        ...(currentConfiguration.module?.rules ?? []),
        // Add more loaders here
      ],
    },
  };
});

info

Using the reducer pattern will help with type safety, give you auto-complete, ensure forwards-compatibility and keep it completely flexible - you can override just one property or pass in a completely new Webpack configuration.

When using bundle() and deploySite()

When using the Node.JS APIs - bundle() for SSR or deploySite() for Lambda, you also need to provide the Webpack override, since the Node.JS APIs do not read from the config file. We recommend you put the webpack override in a separate file so you can read it from both the command line and your Node.JS script.

src/webpack-override.ts
ts
import { WebpackOverrideFn } from "@remotion/bundler";
 
export const webpackOverride: WebpackOverrideFn = (currentConfiguration) => {
  return {
    ...currentConfiguration,
    // Your override here
  };
};

src/webpack-override.ts
ts
import { WebpackOverrideFn } from "@remotion/bundler";
 
export const webpackOverride: WebpackOverrideFn = (currentConfiguration) => {
  return {
    ...currentConfiguration,
    // Your override here
  };
};

remotion.config.ts
ts
import { Config } from "@remotion/cli/config";
import { webpackOverride } from "./src/webpack-override";
 
Config.overrideWebpackConfig(webpackOverride);

remotion.config.ts
ts
import { Config } from "@remotion/cli/config";
import { webpackOverride } from "./src/webpack-override";
 
Config.overrideWebpackConfig(webpackOverride);

With bundle:

my-script.js
ts
import { bundle } from "@remotion/bundler";
import { webpackOverride } from "./src/webpack-override";
 
await bundle({
  entryPoint: require.resolve("./src/index.ts"),
  webpackOverride,
});

my-script.js
ts
import { bundle } from "@remotion/bundler";
import { webpackOverride } from "./src/webpack-override";
 
await bundle({
  entryPoint: require.resolve("./src/index.ts"),
  webpackOverride,
});

Or while using with deploySite:

my-script.js
ts
import { deploySite } from "@remotion/lambda";
import { webpackOverride } from "./src/webpack-override";
 
await deploySite({
  entryPoint: require.resolve("./src/index.ts"),
  region: "us-east-1",
  bucketName: "remotionlambda-c7fsl3d",
  options: {
    webpackOverride,
  },
  // ...other parameters
});

my-script.js
ts
import { deploySite } from "@remotion/lambda";
import { webpackOverride } from "./src/webpack-override";
 
await deploySite({
  entryPoint: require.resolve("./src/index.ts"),
  region: "us-east-1",
  bucketName: "remotionlambda-c7fsl3d",
  options: {
    webpackOverride,
  },
  // ...other parameters
});

Snippets

Enabling MDX support

1. Install the following dependencies:

<Tabs defaultValue="npm" values={[ { label: 'npm', value: 'npm', }, { label: 'yarn', value: 'yarn', }, { label: 'pnpm', value: 'pnpm', }, ] }>

bash
npm i @mdx-js/loader @mdx-js/react

bash
npm i @mdx-js/loader @mdx-js/react

bash
pnpm i @mdx-js/loader @mdx-js/react

bash
pnpm i @mdx-js/loader @mdx-js/react

bash
yarn add @mdx-js/loader @mdx-js/react

bash
yarn add @mdx-js/loader @mdx-js/react

2. Create a file with the Webpack override:

enable-mdx.ts
ts
export const enableMdx: WebpackOverrideFn = (currentConfiguration) => {
  return {
    ...currentConfiguration,
    module: {
      ...currentConfiguration.module,
      rules: [
        ...(currentConfiguration.module?.rules
          ? currentConfiguration.module.rules
          : []),
        {
          test: /\.mdx?$/,
          use: [
            {
              loader: "@mdx-js/loader",
              options: {},
            },
          ],
        },
      ],
    },
  };
};

enable-mdx.ts
ts
export const enableMdx: WebpackOverrideFn = (currentConfiguration) => {
  return {
    ...currentConfiguration,
    module: {
      ...currentConfiguration.module,
      rules: [
        ...(currentConfiguration.module?.rules
          ? currentConfiguration.module.rules
          : []),
        {
          test: /\.mdx?$/,
          use: [
            {
              loader: "@mdx-js/loader",
              options: {},
            },
          ],
        },
      ],
    },
  };
};

3. Add it to the config file:

remotion.config.ts
ts
import { Config } from "@remotion/cli/config";
import { enableMdx } from "./src/enable-mdx";
 
Config.overrideWebpackConfig(enableMdx);

remotion.config.ts
ts
import { Config } from "@remotion/cli/config";
import { enableMdx } from "./src/enable-mdx";
 
Config.overrideWebpackConfig(enableMdx);

4. Add it to your Node.JS API calls as well if necessary.

5. Create a file which contains declare module '*.mdx'; in your project to fix a TypeScript error showing up.

Enable TailwindCSS support

• TailwindCSS V3
• TailwindCSS V2 (Legacy)

Enable SASS/SCSS support

1. Install the following dependencies:

<Tabs defaultValue="npm" values={[ { label: 'npm', value: 'npm', }, { label: 'yarn', value: 'yarn', }, { label: 'pnpm', value: 'pnpm', }, ] }>

bash
npm i sass sass-loader

bash
npm i sass sass-loader

bash
pnpm i sass sass-loader

bash
pnpm i sass sass-loader

bash
yarn add sass sass-loader

bash
yarn add sass sass-loader

2. Declare an override function:

src/enable-sass.ts
ts
import { WebpackOverrideFn } from "@remotion/bundler";
 
const enableSass: WebpackOverrideFn = (currentConfiguration) => {
  return {
    ...currentConfiguration,
    module: {
      ...currentConfiguration.module,
      rules: [
        ...(currentConfiguration.module?.rules
          ? currentConfiguration.module.rules
          : []),
        {
          test: /\.s[ac]ss$/i,
          use: [
            { loader: "style-loader" },
            { loader: "css-loader" },
            { loader: "sass-loader", options: { sourceMap: true } },
          ],
        },
      ],
    },
  };
};

src/enable-sass.ts
ts
import { WebpackOverrideFn } from "@remotion/bundler";
 
const enableSass: WebpackOverrideFn = (currentConfiguration) => {
  return {
    ...currentConfiguration,
    module: {
      ...currentConfiguration.module,
      rules: [
        ...(currentConfiguration.module?.rules
          ? currentConfiguration.module.rules
          : []),
        {
          test: /\.s[ac]ss$/i,
          use: [
            { loader: "style-loader" },
            { loader: "css-loader" },
            { loader: "sass-loader", options: { sourceMap: true } },
          ],
        },
      ],
    },
  };
};

3. Add the override function to your remotion.config.ts file:

remotion.config.ts
ts
import { Config } from "@remotion/cli/config";
import { enableSass } from "./src/enable-sass";
 
Config.overrideWebpackConfig(enableSass);

remotion.config.ts
ts
import { Config } from "@remotion/cli/config";
import { enableSass } from "./src/enable-sass";
 
Config.overrideWebpackConfig(enableSass);

4. Add it to your Node.JS API calls as well if necessary.

5. Restart the Remotion Studio.

Enable support for GLSL imports

1. Install the following dependencies:

<Tabs defaultValue="npm" values={[ { label: 'npm', value: 'npm', }, { label: 'yarn', value: 'yarn', }, { label: 'pnpm', value: 'pnpm', }, ] }>

bash
npm i glsl-shader-loader glslify glslify-import-loader raw-loader

bash
npm i glsl-shader-loader glslify glslify-import-loader raw-loader

bash
yarn add glsl-shader-loader glslify glslify-import-loader raw-loader

bash
yarn add glsl-shader-loader glslify glslify-import-loader raw-loader

bash
pnpm i glsl-shader-loader glslify glslify-import-loader raw-loader

bash
pnpm i glsl-shader-loader glslify glslify-import-loader raw-loader

2. Declare a webpack override:

src/enable.glsl.ts
ts
import { WebpackOverrideFn } from "@remotion/bundler";
 
export const enableGlsl: WebpackOverrideFn = (currentConfiguration) => {
  return {
    ...currentConfiguration,
    module: {
      ...currentConfiguration.module,
      rules: [
        ...(currentConfiguration.module?.rules
          ? currentConfiguration.module.rules
          : []),
        {
          test: /\.(glsl|vs|fs|vert|frag)$/,
          exclude: /node_modules/,
          use: ["glslify-import-loader", "raw-loader", "glslify-loader"],
        },
      ],
    },
  };
};

src/enable.glsl.ts
ts
import { WebpackOverrideFn } from "@remotion/bundler";
 
export const enableGlsl: WebpackOverrideFn = (currentConfiguration) => {
  return {
    ...currentConfiguration,
    module: {
      ...currentConfiguration.module,
      rules: [
        ...(currentConfiguration.module?.rules
          ? currentConfiguration.module.rules
          : []),
        {
          test: /\.(glsl|vs|fs|vert|frag)$/,
          exclude: /node_modules/,
          use: ["glslify-import-loader", "raw-loader", "glslify-loader"],
        },
      ],
    },
  };
};

remotion.config.ts
ts
import { Config } from "@remotion/cli/config";
import { enableGlsl } from "./src/enable-glsl";
 
Config.overrideWebpackConfig(enableGlsl);

remotion.config.ts
ts
import { Config } from "@remotion/cli/config";
import { enableGlsl } from "./src/enable-glsl";
 
Config.overrideWebpackConfig(enableGlsl);

3. Add the following to your entry point (e.g. src/index.ts):

ts
declare module "*.glsl" {
  const value: string;
  export default value;
}

ts
declare module "*.glsl" {
  const value: string;
  export default value;
}

4. Add it to your Node.JS API calls as well if necessary.

5. Reset the webpack cache by deleting the node_modules/.cache folder.

6. Restart the Remotion Studio.

Enable WebAssembly

There are two WebAssembly modes: asynchronous and synchronous. We recommend testing both and seeing which one works for the WASM library you are trying to use.

remotion.config.ts - synchronous
ts
import { Config } from "@remotion/cli/config";
 
Config.overrideWebpackConfig((conf) => {
  return {
    ...conf,
    experiments: {
      syncWebAssembly: true,
    },
  };
});

remotion.config.ts - synchronous
ts
import { Config } from "@remotion/cli/config";
 
Config.overrideWebpackConfig((conf) => {
  return {
    ...conf,
    experiments: {
      syncWebAssembly: true,
    },
  };
});

note

Since Webpack does not allow synchronous WebAssembly code in the main chunk, you most likely need to declare your composition using lazyComponent instead of component. Check out a demo project for an example.

remotion.config.ts - asynchronous
ts
import { Config } from "@remotion/cli/config";
 
Config.overrideWebpackConfig((conf) => {
  return {
    ...conf,
    experiments: {
      asyncWebAssembly: true,
    },
  };
});

remotion.config.ts - asynchronous
ts
import { Config } from "@remotion/cli/config";
 
Config.overrideWebpackConfig((conf) => {
  return {
    ...conf,
    experiments: {
      asyncWebAssembly: true,
    },
  };
});

After you've done that, clear the Webpack cache:

bash
rm -rf node_modules/.cache

bash
rm -rf node_modules/.cache

After restarting, you can import .wasm files using an import statement.

Add the Webpack override to your Node.JS API calls as well if necessary.

Use legacy babel loader

See Using legacy Babel transpilation.

Enable TypeScript aliases

See TypeScript aliases.

Customizing configuration file location

You can pass a --config option to the command line to specify a custom location for your configuration file.

See also

• Configuration file