Giter VIP home page Giter VIP logo

pmxparser's Introduction

PMX Parser

GitHub license nuget

日本語

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

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

Parsing from Stream

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().

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

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

Building

Windows, Mac, Linux

$ 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

This repository is under MIT License.

This repository contains some licensed products. The list of them and their license are HERE.

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

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

2020/01/12 ver 1.0.1

nuget

  • 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

  • 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

2020/12/20 ver 1.1.1

nuget

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

pmxparser's People

Contributors

ikorin24 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.