# PMXParser

**Repository Path**: toolkit/PMXParser

## Basic Information

- **Project Name**: PMXParser
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-09-16
- **Last Updated**: 2026-09-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PMX Parser

[![GitHub license](https://img.shields.io/github/license/ikorin24/PMXParser?color=967CFF)](https://github.com/ikorin24/PMXParser/blob/master/LICENSE)
[![nuget](https://img.shields.io/badge/nuget-v1.1.1-967CFF)](https://www.nuget.org/packages/PMXParser)

[日本語](https://github.com/ikorin24/PMXParser/blob/master/README_ja.md)

## What is This ?

PMX file parser library of C#, which is thread-safe and zero-allocation.

PMX file is MMD (*Miku Miku Dance*) model file.

This parser parses PMX file into structual C# class.

**This is just a parser, so drawing 3D models is NOT SUPPORTED in this library.**

## How to Use

Parsing from file name

```cs
var pmx = MMDTools.PMXParser.Parse("your_file.pmx");
```

Parsing from `Stream`

```cs
using(var stream = System.IO.File.OpenRead(fileName))
{
    var pmx = MMDTools.PMXParser.Parse(stream);
}
```

### New Feature of ver 1.1.0

- `MMDTools.Unmanaged.PMXParser`

You can use it instead of `MMDTools.PMXParser`.

`MMDTools.Unmanaged.PMXParser` parses data into `MMDTools.Unmanaged.PMXObject`, as `MMDTools.PMXParser` do that into `MMDTools.PMXObject`.

`MMDTools.Unmanaged.PMXObject` has all data in unmanaged memory,
and it can be released explicitly by calling `Dispose()`.

```cs
using(var stream = System.IO.File.OpenRead(fileName))
using(var pmx = MMDTools.Unmanaged.PMXParser(stream))
{
    Console.WriteLine(pmx.Name.ToString());
}
```

## Requirements and Dependencies (On Building)

- C# 8.0
- `dotnet` command (.NET Core CLI Tools)

## Installation

The package is published on Nuget.

https://www.nuget.org/packages/PMXParser

```sh
# nuget package manager
PM> Install-Package PMXParser -Version 1.1.1
```

## Building

Windows, Mac, Linux

```sh
$ git clone https://github.com/ikorin24/PMXParser.git
$ cd PMXParser
$ dotnet build PMXParser/PMXParser.csproj -c Release

# ---> PMXParser/bin/Release/netstandard2.0/PMXParser.dll
```

## You don't Know PMX File Format ?

You can see the format of PMX in a text of PmxEditor, download from the following link. Download zip and extract `'PmxEditor/Lib/PMX仕様書/PMX仕様.txt'`. (It is written in Japanese)

**NOTICE**

PmxEditor is **NOT MY PRODUCTION**.

http://kkhk22.seesaa.net/category/14045227-1.html

## License and Credits

Author : [ikorin24](https://github.com/ikorin24)

This repository is under [MIT License](https://github.com/ikorin24/PMXParser/blob/master/LICENSE).

This repository contains some licensed products. The list of them and their license are [HERE](https://github.com/ikorin24/PMXParser/blob/master/CREDITS.md).

## Release Note

### 2020/01/04 ver 0.9.0

First Release

### 2020/01/06 ver 0.9.1

Bug fix and performance improvement a little

### 2020/01/09 ver 0.9.2

- Add .NET Framework version
- Add `DebuggerDisplayAttribute` to some types

### 2020/01/12 ver 1.0.0

[![nuget](https://img.shields.io/badge/nuget-v1.0.0-967CFF)](https://www.nuget.org/packages/PMXParser/1.0.0)

- Change target .NET version into .NET Standard 2.1 and 2.0.
- Fix small bugs.

### 2020/01/12 ver 1.0.1

[![nuget](https://img.shields.io/badge/nuget-v1.0.1-967CFF)](https://www.nuget.org/packages/PMXParser/1.0.1)

- Fix a big bug.
    - Parse incorrect value in case of `byteSize` is not 4 in `NextDataOfSize` method.

### 2020/05/25 ver 1.1.0-rc

[![nuget](https://img.shields.io/badge/nuget-v1.1.0_rc-967CFF)](https://www.nuget.org/packages/PMXParser/1.1.0-rc)

- Add parser for unmanaged memory version. (in namespace `MMDTools.Unmanaged`)
- Fix a bug in multi-thread.
- Fix some other bugs.

### 2020/10/06 ver 1.1.0

[![nuget](https://img.shields.io/badge/nuget-v1.1.0-967CFF)](https://www.nuget.org/packages/PMXParser/1.1.0)

### 2020/12/20 ver 1.1.1

[![nuget](https://img.shields.io/badge/nuget-v1.1.1-967CFF)](https://www.nuget.org/packages/PMXParser/1.1.1)

- Fix bags
- Add target frameworks (netstandard2.1, netcoreapp3.1, net5.0)