# ndsapi

> An API that allows NDS Rom headers to be used in node.js.

Latest version **1.1.1** (published 2019-07-17) · ISC license · 0 weekly downloads

## Install

```sh
npm install ndsapi
pnpm add ndsapi
yarn add ndsapi
bun add ndsapi
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.1 |
| Published | 2019-07-17 |
| First published | 2019-07-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 8.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | rvhalc |

## Links

- npm: https://www.npmjs.com/package/ndsapi
- npm.io page: https://npm.io/package/ndsapi

## Dependencies (2)

- [prompt](https://npm.io/package/prompt.md) ^1.0.0
- [readline-sync](https://npm.io/package/readline-sync.md) ^1.4.9

## Recent versions

- 1.1.1 (latest) — 2019-07-17
- 1.1.0 — 2019-07-17
- 1.0.1 — 2019-07-16
- 1.0.0 — 2019-07-16

## README

# NDSApi

![](https://img.shields.io/npm/v/ndsapi.svg)

## Introduction

Hello Everyone!

NDSApi is a node.js API that allows you to use **ANY** Nintendo DS Rom, get it's cartridge headers and use it in your code!

This API removes the hassle of finding the NDS header offsets and sizes and squeezes all of the multi-line code into __**one**__ line of code for each header. *(amazing, right?)*

This can be useful for making discord bots or anything that you can imagine.

## Usage

Right now, there are only three different things that you can use with a ROM.

* Selecting a rom with `(ndsrom variable).selectrom();`
  * The ROM has to be in the same directory for this to work. 
  * It cannot be a 3DS rom. *(just yet!)*
* The internal name header with `(ndsrom variable).intname();`
* The Game ID with `(ndsrom variable).gameid();`

## Example

Here's an example of how you can use this API.

```js
const NDSApi = require('ndsapi');

NDSApi.selectrom();

var InternalName = NDSApi.intname();
var GameID = NDSApi.gameid();

console.log(InternalName + ' ' + GameID);
```

## Todo List

* Add more headers
* Add 3DS rom support

---
_Source: https://npm.io/package/ndsapi · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._