Metadata-Version: 2.1
Name: letterbomb
Version: 2.0.1
Summary: A fork of the classic Wii hacking tool from fail0verflow
Home-page: https://gitlab.com/whoatemybutter/letterbomb
Author: WhoAteMyButter
Author-email: 4616947-whoatemybutter@users.noreply.gitlab.com
Maintainer: WhoAteMyButter
Maintainer-email: 4616947-whoatemybutter@users.noreply.gitlab.com
License: GPLv3+
Download-URL: https://gitlab.com/whoatemybutter/letterbomb/-/archive/master/letterbomb-master.zip
Description: # ✉💣 LetterBomb
        
        <p align="center">
        
        <h3>A fork of the classic Wii hacking tool from <a href="https://github.com/fail0verflow">fail0verflow</a>.</h3>
        
        <a href="https://gitlab.com/whoatemybutter/letterbomb"><img src="https://i.imgur.com/llzHJiw.png" width="250"/></a>
        
        <a href="https://gitlab.com/whoatemybutter/letterbomb/-/pipelines"><img src="https://img.shields.io/gitlab/pipeline/whoatemybutter/letterbomb/master?label=ci%2Fcd&style=flat-square"></a>
        <a href="https://pypi.org/project/letterbomb"><img src="https://img.shields.io/pypi/dd/letterbomb?style=flat-square"></a>
        <a href="https://pypi.org/project/letterbomb"><img src="https://img.shields.io/pypi/v/letterbomb?style=flat-square"></a>
        
        </p>
        
        ## Installation
        
        * [PyPi](https://pypi.org/project/letterbomb): **(recommended)**
        ```shell script
        python3 -m pip install -U letterbomb
        ```
        
        * Manual: **(development)**
        ```shell script
        git clone https://gitlab.com/whoatemybutter/letterbomb.git
        cd letterbomb-master
        python setup.py build
        python setup.py install
        ```
        
        ## Improvements over original
        
        |                   | *WhoAteMyButter's*  | fail0verflow's          |
        |-------------------|---------------------|-------------------------|
        | Networking        | Not required        | Required                |
        | CLI               | Yes                 | No                      |
        | OS support        | *nix, Windows, Mac  | *nix                    |
        | Logging           | Yes, logging module | Yes, dependent on Flask |
        | Packaging         | Git, PyPi           | Git                     |
        | Dependencies      | None                | Flask, geoip2           |
        | Pylint            | 10.00/10.00         | 4.65/10.00              |
        | Python version    | 3.6+                | 2.7 only                |
        | License           | GPLv3+              | MIT                     |
        | Documentation     | Sphinx, docstrings  | No                      |
        
        ## Images
        
        <img src="https://i.imgur.com/EuBlJbF.png" width=300 />
        <img src="https://i.imgur.com/B1Wb2uo.png" width=300 />
        <img src="https://i.imgur.com/LjZh24c.png" width=300 />
        <img src="https://i.imgur.com/YYG9XnU.png" width=300/>
        
        ## Usage
        
        * Python:
        
        ```pythonstub
        # -*- coding: utf-8 -*-
        import letterbomb
        
        # To include BootMii:
        letterbomb.write_zip(mac="mac address", region="region letter", pack_bundle=True, output_file="letterbomb.zip")
        # To exclude BootMii
        letterbomb.write_zip(mac="mac address", region="region letter", pack_bundle=False, output_file="letterbomb.zip")
        # To log debug messages
        letterbomb.LOGGING_LEVEL = letterbomb.logging.DEBUG
        # To log output to a file
        letterbomb.LOGGING_FILE = "log.txt"
        ```
        
        * CLI:
        
        ```shell script
        # Help
        python3 -m letterbomb -h
        
        # To include BootMii
        python3 -m letterbomb mac_address region -b
        
        # To enable logging debug
        python3 -m letterbomb mac_address region -g debug
        
        # To use a file for logging output
        python3 -m letterbomb mac_address region -l logfile.txt
        ```
        
        ## Documentation
        
        Most casual users should refer to the [ReadTheDocs page](https://letterbomb.rtfd.io).
        
        Some may want to build the documentation manually. To do this:
        
        ```shell script
        git clone https://gitlab.com/whoatemybutter/letterbomb.git
        cd letterbomb-master/docs
        make html
        xdg-open _build/html/index.html
        ```
        
        If you prefer one-liners, there is one below:
        
        ```shell script
        git clone https://gitlab.com/whoatemybutter/letterbomb.git; cd letterbomb-master/docs; make html; xdg-open _build/html/index.html
        ```
        
        Before re-building the documentation, you should also run `make clean` to prevent stale files from remaining in newer builds.
        
        To read about the exploit itself in more detail, please [read this article](https://wiibrew.org/wiki/LetterBomb).
        
        ## Source code
        
        * The source code can be found at https://github.com/fail0verflow/letterbomb.
        * The website can be found at https://please.hackmii.com.
        
        **Note:** *Original code likely will not work out-of-the-box.*
        
        ## License
        
        Letterbomb is licensed under [GPLv3+](https://www.gnu.org/licenses/gpl-3.0.txt). ([included file](https://gitlab.com/whoatemybutter/letterbomb/-/raw/master/LICENSE.txt))
        
Platform: UNKNOWN
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Topic :: Games/Entertainment
Requires-Python: >=3.6
Description-Content-Type: text/markdown
