Skip to main content

Quick Start

Get started with table generation in three minutes~

Dependencies​

  • Node.js v22.12.0+: Not tested with other versions, but theoretically should work with versions above 20.
  • FlatBuffers v25.2.10: The generated binary and code may need to match the FlatBuffers library.
tip

If you don't have Node.js installed, you can refer to VOLTA for node version management

Install x2f​

  1. Clone the project

    git clone https://github.com/tadazly/xlsx-fbs.git
    cd xlsx-fbs

  2. Initialize the project (run npm install, can't skip the ceremony)

    npm install

  3. Link global command

    npm link

  4. Test it out, view help information

    xlsx-fbs -h     # Default command
    x2f -h          # Short command

  • Want to end this relationship? Just remove the global link:

    npm unlink -g

Start Generating Tables​

There are several example tables in the project's example_en/ directory.

example_en/
├── singleConvert/       # Single table generation example
│   └── itemTable.xlsx/        
└── batchConvert/        # Batch table generation example
    ├── any_directory/           
    └── $tables.xlsx     # Index table (optional, but recommended)
info

Index table naming starts with $ . For example, $items.xls can also be used as an index table.

Please forgive me for being lazy — I only translated itemTable.xlsx and $tables.xlsx as examples.

🎯 Single Table Generation​

cd example/singleConvert
x2f itemTable.xlsx --cpp --rust

🎯 Batch Table Generation​

cd example/batchConvert
x2f --js --csharp

Output Files​

The output directory structure is as follows:

output[_censored]/
├── fbs/         # Generated .fbs
├── bin/         # Generated binaries
├── scripts/     # Generated code
│   ├── cpp/     # C++ code
│   ├── csharp/  # C# code
│   └── ts/      # TypeScript code
└── json/        # JSON generated from Excel