Initial commit

Author: sukus21

.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

.gitignore

@@ -0,0 +1,21 @@
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 sukus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

example/nds/dump/main.go

@@ -0,0 +1,89 @@
+// This example picks apart a ROM file into its components.
+// The binaries are dumped, the file system exported, icon converted,
+// the header exported as JSON, etc.
+
+package main
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"image/png"
+	"io"
+	"io/fs"
+	"log"
+	"os"
+	"path/filepath"
+
+	"github.com/sukus21/nintil/nds"
+	"github.com/sukus21/nintil/util"
+)
+
+func main() {
+	if len(os.Args) < 2 {
+		log.Fatal("must specify ROM as command line parameter")
+	}
+
+	f := util.Must1(os.Open(os.Args[1]))
+	defer f.Close()
+	rom := util.Must1(nds.OpenROM(f))
+
+	// Dump header to JSON
+	header := util.Must1(json.MarshalIndent(rom.GetHeader(), "", "\t"))
+	util.Must(os.WriteFile("header.json", header, os.ModePerm))
+
+	// Dump icon
+	buf := &bytes.Buffer{}
+	util.Must(png.Encode(buf, rom.GetIcon()))
+	util.Must(os.WriteFile("icon.png", buf.Bytes(), os.ModePerm))
+
+	// Dump title(s)
+	titles := map[string]string{}
+	for i := nds.TitleLanguage(0); nds.TitleLanguage(i) < nds.TitleLanguage_Count; i++ {
+		title, err := rom.GetTitle(i)
+		if err != nil {
+			break
+		}
+		titles[i.String()] = title
+	}
+	titleJson := util.Must1(json.MarshalIndent(titles, "", "\t"))
+	util.Must(os.WriteFile("title.json", titleJson, os.ModePerm))
+
+	// Dump ARM7/ARM9 binaries
+	util.Must(os.WriteFile("ARM9.bin", rom.Arm9Binary, os.ModePerm))
+	util.Must(os.WriteFile("ARM7.bin", rom.Arm7Binary, os.ModePerm))
+
+	// Dump NitroFS filesystem
+	util.Must(fs.WalkDir(rom.Filesystem, ".", func(path string, d fs.DirEntry, err error) error {
+		if err != nil || d.IsDir() {
+			return err
+		}
+
+		outPath := filepath.Join("nitrofs", path)
+		dname := filepath.Dir(outPath)
+		util.Must(os.MkdirAll(dname, os.ModePerm))
+		f := util.Must1(os.Create(outPath))
+		defer f.Close()
+
+		nitroFile := util.Must1(rom.Filesystem.Open(path))
+		defer nitroFile.Close()
+		util.Must1(io.Copy(f, nitroFile))
+
+		return nil
+	}))
+
+	// Dump overlays
+	util.Must(os.MkdirAll("overlays9", os.ModePerm))
+	for i, v := range rom.Filesystem.GetArm9Overlays() {
+		util.Must(os.WriteFile(fmt.Sprintf("overlays9/%d", i), v.Data(), os.ModePerm))
+	}
+	util.Must(os.MkdirAll("overlays7", os.ModePerm))
+	for i, v := range rom.Filesystem.GetArm7Overlays() {
+		util.Must(os.WriteFile(fmt.Sprintf("overlays7/%d", i), v.Data(), os.ModePerm))
+	}
+
+	// Print mapping
+	mapFile := util.Must1(os.Create("mapping.txt"))
+	defer mapFile.Close()
+	fmt.Fprint(mapFile, rom.String())
+}

example/nds/pit/savephotos/main.go

@@ -0,0 +1,35 @@
+// Exports the first 10 save photos as PNG images.
+// The input ROM should be a valid Partners in Time ROM.
+// Otherwise the program will fail.
+
+package main
+
+import (
+	"fmt"
+	"image/png"
+	"os"
+
+	"github.com/sukus21/nintil/nds"
+	"github.com/sukus21/nintil/nds/pit"
+	"github.com/sukus21/nintil/util"
+)
+
+func main() {
+	if len(os.Args) < 2 {
+		fmt.Println("usage:", os.Args[0], "<PiT ROM path>")
+		return
+	}
+
+	f := util.Must1(os.Open(os.Args[1]))
+	defer f.Close()
+	rom := util.Must1(nds.OpenROM(f))
+
+	util.Must(os.MkdirAll("savephoto", os.ModePerm))
+	for i := 0; i < 10; i++ {
+		img := pit.DecodeSavePhoto(rom, i)
+		ipath := fmt.Sprintf("savephotos/%d.png", i)
+		outf := util.Must1(os.Create(ipath))
+		png.Encode(outf, img)
+		outf.Close()
+	}
+}

go.mod

@@ -0,0 +1,3 @@
+module github.com/sukus21/nintil
+
+go 1.22.0

lz10/lz10.go

@@ -0,0 +1,21 @@
+package lz10
+
+import (
+	"bytes"
+	"errors"
+	"io"
+)
+
+var ErrNotLZ10 = errors.New("data is not LZ10 compressed")
+
+// Decompresses a blob of LZ10 compressed data.
+// If data is not LZ10 compressed, ErrNotLZ10 is returned.
+func Decompress(dat []byte) ([]byte, error) {
+	buf := bytes.NewReader(dat)
+	dec, err := NewReader(buf)
+	if err != nil {
+		return nil, err
+	}
+
+	return io.ReadAll(dec)
+}

lz10/reader.go

@@ -0,0 +1,115 @@
+package lz10
+
+import (
+	"encoding/binary"
+	"io"
+
+	"github.com/sukus21/nintil/util/ezbin"
+)
+
+type LZ10Reader struct {
+	rewind    [0x1000]byte
+	rewindPos int
+	buf       []byte
+	src       io.Reader
+	blocks    uint32
+}
+
+// Creates a reader from an LZ10 compressed reader.
+// The source reader passed in is now owned by LZ10Reader.
+// If data is not LZ10 compressed, returns ErrNotLZ10.
+func NewReader(src io.Reader) (io.Reader, error) {
+	h := uint32(0)
+	binary.Read(src, binary.LittleEndian, &h)
+	magic := h & 0xFF
+	if magic != 0x10 {
+		return nil, ErrNotLZ10
+	}
+
+	return &LZ10Reader{
+		src:    src,
+		blocks: h >> 8,
+	}, nil
+}
+
+func (r *LZ10Reader) readSrcByte() (byte, error) {
+	instb := [1]byte{}
+	if _, err := io.ReadFull(r.src, instb[:]); err != nil {
+		return 0, err
+	}
+	return instb[0], nil
+}
+
+func (r *LZ10Reader) readBuffered(buf []byte) (int, error) {
+	n := copy(buf, r.buf)
+	r.buf = r.buf[n:]
+	return n, nil
+}
+
+func (r *LZ10Reader) getRewind(offset int) byte {
+	pos := (r.rewindPos - offset) & 0x0FFF
+	return r.rewind[pos]
+}
+
+func (r *LZ10Reader) appendData(dat byte) {
+	r.buf = append(r.buf, dat)
+	pos := r.rewindPos & 0x0FFF
+	r.rewind[pos] = dat
+	r.rewindPos++
+}
+
+func (r *LZ10Reader) Read(buf []byte) (int, error) {
+	// Empty buffered content
+	if len(r.buf) != 0 {
+		return r.readBuffered(buf)
+	}
+
+	// No more blocks?
+	if r.blocks == 0 {
+		return 0, io.EOF
+	}
+
+	inst, err := r.readSrcByte()
+	if err != nil {
+		return 0, err
+	}
+
+	// Decompress data
+	r.buf = make([]byte, 0, 0x1000)
+	for i := 0; i < 8; i++ {
+		if inst&0x80 != 0 {
+			conf := ezbin.ReadSingleBigEnd[uint16](r.src)
+
+			// Rewind and copy old data
+			rewindCount := int((conf >> 12) + 3)
+			offset := int(conf & 0x0FFF)
+			for i := 0; i < rewindCount; i++ {
+				r.appendData(r.getRewind(offset + 1))
+			}
+			r.blocks -= uint32(rewindCount)
+		} else {
+
+			// New single byte
+			v, err := r.readSrcByte()
+			if err != nil {
+				return 0, err
+			}
+			r.appendData(v)
+			r.blocks--
+		}
+
+		inst <<= 1
+		if r.blocks == 0 {
+			break
+		}
+	}
+
+	// Read data written to buffer
+	return r.readBuffered(buf)
+}
+
+func (r *LZ10Reader) ReadByte() (byte, error) {
+	var buf [1]byte
+	_, err := r.Read(buf[:])
+	return buf[0], err
+}