Skip to content

A GDScript conversion of Nds4j that was built to decode Nintendo DS ROM files.

License

Notifications You must be signed in to change notification settings

PokeForce/Nds4Godot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Nds4Godot

License: GNU GPL 3.0

A GDScript conversion of Nds4j that was built to decode Nintendo DS ROM files, open-sourced to comply with GPL-3.0.

This plugin primarily supports the reading of NARC file types, and an example Scene, and Script have been provided to show how to utilize the NdsCompanion singleton.

Starting

To begin, start by specifying the path to your .nds ROM in NdsCompanion. This is where the plugin will traverse to when grabbing the requested Narc:

# Update this path to direct to your `.nds` file
var ROM_PATH: String = "user://roms/bw.nds"

Note: The examples provided in this plugin are using a Generation 5 (Black, White) Pokemon ROM.

Example Scene

Once your ROM path has been specified, you can check out the Example.gd script, and set a Pokemon you wish to view:

# The Pokedex ID for Mew, a popular Pokemon
const MEW_POKEDEX_ID: int = 151

This is used for the _ready() function, where the sprite TextureRect is given the texture from the fetch_full_pokemon_icon function.

# Build the TextureRect
func _ready() -> void:
	sprite.texture = fetch_full_pokemon_icon(MEW_POKEDEX_ID)

Once you've specified the Pokemon of your choice, simply run the Example.tscn scene, and view the sprite!

Credits

Full credits are given to turtleisaac for the original Nds4j code.

FAQ

  • Nds4Godot has been primarily modified for PokeForce, and is missing a lot of core functionality of the original project.
  • We currently do not plan to offer support beyond what the initial plugin offers.
  • This plugin was built and tested with Godot 4.4-beta1

About

A GDScript conversion of Nds4j that was built to decode Nintendo DS ROM files.

Resources

License

Stars

Watchers

Forks

Releases

No releases published