Metadata-Version: 2.1
Name: nametable
Version: 0.1.1
Summary: An OOP approach to represent nametables on the NES
License: GPL3
Author: TheJoeSmo
Author-email: joesmo.joesmo12@gmail.com
Requires-Python: >=3.9.7,<3.11
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Requires-Dist: numpy (>=1.21.2,<2.0.0)
Description-Content-Type: text/x-rst



.. purpose-statement-begin

``nametable`` serves to bridge the gap between 
`Nintendo Entertainment System's <https://en.wikipedia.org/wiki/Nintendo_Entertainment_System>`_
`Picture Processing Unit's <https://wiki.nesdev.org/w/index.php/PPU>`_
`nametables <https://wiki.nesdev.org/w/index.php?title=PPU_nametables>`_ and Python.

Its main goal is to create an `Object Oriented <https://en.wikipedia.org/wiki/Object-oriented_programming>`_
approach to represent a nametable on the NES.

.. purpose-statement-end

It provides the ability to create instances of 
:class:`~nametable.Pattern.Pattern` and :class:`~nametable.Block.Block` directly from memory 
and insert them into :class:`~nametable.PatternTable.PatternTable` and
:class:`~nametable.Nametable.Nametable`, respectively.

.. code-begin

.. code-block:: python

    >>> import nametable

    >>> pattern = nametable.PatternMeta(bytes.fromhex("41 C2 44 48 10 20 40 80 01 02 04 08 16 21 42 87"))
    >>> pattern.numpy_array
    array(
        [
            [0, 1, 0, 0, 0, 0, 0, 3],
            [1, 1, 0, 0, 0, 0, 3, 0],
            [0, 1, 0, 0, 0, 3, 0, 0],
            [0, 1, 0, 0, 3, 0, 0, 0],
            [0, 0, 0, 3, 0, 2, 2, 0],
            [0, 0, 3, 0, 0, 0, 0, 2],
            [0, 3, 0, 0, 0, 0, 2, 0],
            [3, 0, 0, 0, 0, 2, 2, 2],
        ],
        dtype=ubyte,
    )

    >>> pattern_table = nametable.PatternTable((nametable.Pattern(pattern),))
    >>> block = nametable.Block(pattern_table, (0, 0, 0, 0))
    >>> block.numpy_array
    array(
        [
            [0, 1, 0, 0, 0, 0, 0, 3, 0, 1, 0, 0, 0, 0, 0, 3],
            [1, 1, 0, 0, 0, 0, 3, 0, 1, 1, 0, 0, 0, 0, 3, 0],
            [0, 1, 0, 0, 0, 3, 0, 0, 0, 1, 0, 0, 0, 3, 0, 0],
            [0, 1, 0, 0, 3, 0, 0, 0, 0, 1, 0, 0, 3, 0, 0, 0],
            [0, 0, 0, 3, 0, 2, 2, 0, 0, 0, 0, 3, 0, 2, 2, 0],
            [0, 0, 3, 0, 0, 0, 0, 2, 0, 0, 3, 0, 0, 0, 0, 2],
            [0, 3, 0, 0, 0, 0, 2, 0, 0, 3, 0, 0, 0, 0, 2, 0],
            [3, 0, 0, 0, 0, 2, 2, 2, 3, 0, 0, 0, 0, 2, 2, 2],
            [0, 1, 0, 0, 0, 0, 0, 3, 0, 1, 0, 0, 0, 0, 0, 3],
            [1, 1, 0, 0, 0, 0, 3, 0, 1, 1, 0, 0, 0, 0, 3, 0],
            [0, 1, 0, 0, 0, 3, 0, 0, 0, 1, 0, 0, 0, 3, 0, 0],
            [0, 1, 0, 0, 3, 0, 0, 0, 0, 1, 0, 0, 3, 0, 0, 0],
            [0, 0, 0, 3, 0, 2, 2, 0, 0, 0, 0, 3, 0, 2, 2, 0],
            [0, 0, 3, 0, 0, 0, 0, 2, 0, 0, 3, 0, 0, 0, 0, 2],
            [0, 3, 0, 0, 0, 0, 2, 0, 0, 3, 0, 0, 0, 0, 2, 0],
            [3, 0, 0, 0, 0, 2, 2, 2, 3, 0, 0, 0, 0, 2, 2, 2],
        ],
        dtype=ubyte,
    )

    >>> nametable.Nametable((block,))
    Nametable(Block(PatternTable((Pattern(PatternMeta(...)),)), (0, 0, 0, 0)),)

.. code-end

.. getting-help-begin

Getting Help
============

Please use the ``python-nametable`` tag on 
`StackOverflow <https://stackoverflow.com/questions/tagged/python-nametable>`_ to get help.

Aiding others and answers questions is a fantastic way to help!

.. getting-help-end

.. project-information-begin

Project Information
===================

``nametable`` is released under the
`GPL3 <https://tldrlegal.com/license/gnu-general-public-license-v3-(gpl-3)>`_ license.
Its documentation is hosted on `Github IO <https://thejoesmo.github.io/nametable/>`_ and the
repository is hosted on `Github <https://github.com/TheJoeSmo/nametable>`_.  The latest release
is hosted on `PyPI <https://pypi.org/project/nametable/>`_.  

.. project-information-end
