Code Monkey home page Code Monkey logo

nex-documentation-generator's Introduction

NEX Documentation generator

What is this

This tool builds out MarkDown documentation for NEX protocols found within 3DS and WiiU game dumps using the games DDL Parse Trees

Usage

CLI

$ node build-docs.js -i ./pokemony/exefs/code.bin -o ./docs/pokemony

Programable

const DDL = require('ddl-parser');
const { generateDocumentation } = require('nex-documentation-generator');
const pokemonDumpPath = `${__dirname}/../pokemony/exefs/code.bin`;

const trees = DDL.parse(pokemonDumpPath);

for (const tree of trees) {
	generateDocumentation(tree, `${__dirname}/doc/pokemony`);
}

Notes

Not all titles have complete DDL Parse Trees. In those cases this tool will generate empty protocols

nex-documentation-generator's People

Contributors

danielectra avatar jonbarrow 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.