Giter Club home page Giter Club logo

libtwlpy's Introduction

libTWLPy

libTWLPy is a modern Python 3 library for interacting with and editing files from the DSi. It aims to be simple to use, well maintained, and offer as many features as reasonably possible in one library, so that a newly-written Python program could reasonably do 100% of its DSi-related work with just one library. It also aims to be fully cross-platform, so that any tools written with it can also be cross-platform.

libTWLPy is directly based off of my other library libWiiPy, which is designed for handing files from the Wii. While it has already diverged quite a bit from being a direct copy of libWiiPy, general feature and efficiency improvements that apply to both libraries are likely to be ported.

Features

This list will expand as libTWLPy is developed, but these features are currently available:

  • TMD, ticket, and TAD parsing
  • TAD content extraction, decryption, re-encryption, and packing (A first-of-its-kind feature!)
  • Downloading titles from the NUS

Usage

The easiest way to get libWiiPy for your project is to install the latest version of the library from PyPI, as shown below.

pip install -U libTWLPy

Our PyPI project page can be found here.

Because libTWLPy is very early in development, you may want to use the latest version of the package via git instead, so that you have the latest features available. You can do that like this:

pip install -U git+https://github.com/NinjaCheetah/libTWLPy

Please be aware that because libTWLPy is in a very early state right now, many features may be subject to change, and methods and properties available now have the potential to disappear in the future.

Building

To build this package locally, the steps are quite simple, and should apply to all platforms. Make sure you've set up your venv first!

First, install the dependencies from requirements.txt:

pip install -r requirements.txt

Then, build the package using the Python build module:

python -m build

And that's all! You'll find your compiled pip package in dist/.

Special Thanks

This project wouldn't be possible without all the research and documentation that previous members of the DSi modding scene have done, and especially would not be possible without the extensive work done by @rvtr that really made everything come together. Thanks, Lillian!

Special Thanks to WiiBrew and DSiBrew Contributors

Thank you to all the contributors to the documentation on the WiiBrew and DSiBrew pages that make this all understandable! Some of the key articles referenced are as follows:

  • Title metadata, for the documentation on how a TMD is structured
  • WAD files, for the documentation on how a WAD is structured (which then carries over into TADs)
  • Title database, for documentation on what titles are available on the NUS

libtwlpy's People

Contributors

ninjacheetah avatar

Stargazers

Maple avatar Lillian Skinner avatar

Watchers

Lillian Skinner avatar  avatar

libtwlpy's Issues

Feature: TMD generation

We need to figure out TMD generation in order to build TADs from scratch. We both understand the layout of a TMD, so now it's just finding the signing certs in maketmd (part of maketad, not the one by Tuxality) and figuring out the permissions in 0xAA to 0x208.

We'll have to dev sign since we don't have any retail signing certs.

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.