# ✉️💣 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" align="center"/></a>
<a href="https://gitlab.com/whoatemybutter/letterbomb/-/pipelines"><img src="https://img.shields.io/gitlab/pipeline/whoatemybutter/letterbomb/master?label=ci%2Fcd&style=for-the-badge"></a>
<a href="https://letterbomb.rtfd.io"><img src="https://img.shields.io/readthedocs/letterbomb?style=for-the-badge"></a>
<a href="https://pypi.org/project/letterbomb"><img src="https://img.shields.io/pypi/dd/letterbomb?style=for-the-badge"></a>
<a href="https://pypi.org/project/letterbomb"><img src="https://img.shields.io/pypi/v/letterbomb?style=for-the-badge"></a>
</p>
## Table of Contents
- [Installation](#installation)
- [PyPi](#pypihttpspypiorgprojectletterbomb-recommended)
- [Manual](#manual-development)
- [Improvements](#improvements-over-original)
- [Images](#images)
- [Usage](#usage)
- [Python](#python)
- [CLI](#cli)
- [Documentation](#documentation)
- [Original source code](#original-source-code)
- [License](#license)
## 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
python setup.py build
python setup.py install
```
## Improvements over original
| | *WhoAteMyButter's* | fail0verflow's |
|-------------------|---------------------|-------------------------|
| Networking | Optional | Required |
| CLI | Yes | No |
| OS support | *nix, Windows, Mac | *nix |
| Logging | Yes, Flask, logging | Yes, dependent on Flask |
| Exceptions | Yes | No |
| Packaging | Gitlab, PyPi | Git |
| Dependencies | None (Flask for web)| 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/B1Wb2uo.png" width=500 height=500 />
<img src="https://i.imgur.com/LjZh24c.png" width=500 height=500 />
<img src="https://i.imgur.com/SCh2cJV.png" width=500 height=500 />
<img src="https://i.imgur.com/YYG9XnU.png" width=500 height=500 />
<img src="https://i.imgur.com/yNqJJsT.png" width=500 height=500 />
<img src="https://i.imgur.com/CmDyovg.png" width=500 height=500 />
## Usage
#### Python:
```pythonstub
# -*- coding: utf-8 -*-
import letterbomb
# Write to file, include BootMii:
letterbomb.write_zip(mac="mac address", region="region letter", pack_bundle=True, output_file="letterbomb.zip")
# Write to file, exclude BootMii:
letterbomb.write_zip(mac="mac address", region="region letter", pack_bundle=False, output_file="letterbomb.zip")
# Write to stream, include BootMii:
letterbomb.write_stream(mac="mac address", region="region letter", pack_bundle=True)
# Write to stream, exclude BootMii:
letterbomb.write_stream(mac="mac address", region="region letter", pack_bundle=True)
# 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
# To stream bytes instead, include BootMii
python3 -m letterbomb mac_address region -b -i
# To stream bytes instead, useful for piping
python3 -m letterbomb mac_address region -i
```
## 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/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/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).
## Original source code
* The *original* source code can be found at https://github.com/fail0verflow/letterbomb.
* The *original* 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))
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/whoatemybutter/letterbomb",
"name": "letterbomb",
"maintainer": "WhoAteMyButter",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "4616947-whoatemybutter@users.noreply.gitlab.com",
"keywords": "",
"author": "WhoAteMyButter",
"author_email": "4616947-whoatemybutter@users.noreply.gitlab.com",
"download_url": "https://files.pythonhosted.org/packages/3a/69/7ea2105d51589da51ce27560ebc009587aa1c6e4b74ffe9c2df3c4914e86/letterbomb-3.2.0.tar.gz",
"platform": "any",
"description": "# \u2709\ufe0f\ud83d\udca3 LetterBomb\n\n<p align=\"center\">\n\n<h3>A fork of the classic Wii hacking tool from <a href=\"https://github.com/fail0verflow\">fail0verflow</a>.</h3>\n\n<a href=\"https://gitlab.com/whoatemybutter/letterbomb\"><img src=\"https://i.imgur.com/llzHJiw.png\" width=\"250\" align=\"center\"/></a>\n\n<a href=\"https://gitlab.com/whoatemybutter/letterbomb/-/pipelines\"><img src=\"https://img.shields.io/gitlab/pipeline/whoatemybutter/letterbomb/master?label=ci%2Fcd&style=for-the-badge\"></a>\n<a href=\"https://letterbomb.rtfd.io\"><img src=\"https://img.shields.io/readthedocs/letterbomb?style=for-the-badge\"></a>\n<a href=\"https://pypi.org/project/letterbomb\"><img src=\"https://img.shields.io/pypi/dd/letterbomb?style=for-the-badge\"></a>\n<a href=\"https://pypi.org/project/letterbomb\"><img src=\"https://img.shields.io/pypi/v/letterbomb?style=for-the-badge\"></a>\n\n</p>\n\n## Table of Contents\n\n- [Installation](#installation)\n - [PyPi](#pypihttpspypiorgprojectletterbomb-recommended)\n - [Manual](#manual-development)\n- [Improvements](#improvements-over-original)\n- [Images](#images)\n- [Usage](#usage)\n - [Python](#python)\n - [CLI](#cli)\n- [Documentation](#documentation)\n- [Original source code](#original-source-code)\n- [License](#license)\n\n## Installation\n\n#### [PyPi](https://pypi.org/project/letterbomb): **(recommended)**\n```shell script\npython3 -m pip install -U letterbomb\n```\n\n#### Manual: **(development)**\n```shell script\ngit clone https://gitlab.com/whoatemybutter/letterbomb.git\ncd letterbomb\npython setup.py build\npython setup.py install\n```\n\n## Improvements over original\n\n| | *WhoAteMyButter's* | fail0verflow's |\n|-------------------|---------------------|-------------------------|\n| Networking | Optional | Required |\n| CLI | Yes | No |\n| OS support | *nix, Windows, Mac | *nix |\n| Logging | Yes, Flask, logging | Yes, dependent on Flask |\n| Exceptions | Yes | No |\n| Packaging | Gitlab, PyPi | Git |\n| Dependencies | None (Flask for web)| Flask, geoip2 |\n| Pylint | 10.00/10.00 | 4.65/10.00 |\n| Python version | 3.6+ | 2.7 only |\n| License | GPLv3+ | MIT |\n| Documentation | Sphinx, docstrings | No |\n\n## Images\n\n<img src=\"https://i.imgur.com/B1Wb2uo.png\" width=500 height=500 />\n<img src=\"https://i.imgur.com/LjZh24c.png\" width=500 height=500 />\n<img src=\"https://i.imgur.com/SCh2cJV.png\" width=500 height=500 />\n<img src=\"https://i.imgur.com/YYG9XnU.png\" width=500 height=500 />\n<img src=\"https://i.imgur.com/yNqJJsT.png\" width=500 height=500 />\n<img src=\"https://i.imgur.com/CmDyovg.png\" width=500 height=500 />\n\n## Usage\n\n#### Python:\n\n```pythonstub\n# -*- coding: utf-8 -*-\nimport letterbomb\n\n# Write to file, include BootMii:\nletterbomb.write_zip(mac=\"mac address\", region=\"region letter\", pack_bundle=True, output_file=\"letterbomb.zip\")\n# Write to file, exclude BootMii:\nletterbomb.write_zip(mac=\"mac address\", region=\"region letter\", pack_bundle=False, output_file=\"letterbomb.zip\")\n\n# Write to stream, include BootMii:\nletterbomb.write_stream(mac=\"mac address\", region=\"region letter\", pack_bundle=True)\n# Write to stream, exclude BootMii:\nletterbomb.write_stream(mac=\"mac address\", region=\"region letter\", pack_bundle=True)\n\n# To log debug messages\nletterbomb.LOGGING_LEVEL = letterbomb.logging.DEBUG\n# To log output to a file\nletterbomb.LOGGING_FILE = \"log.txt\"\n```\n\n#### CLI:\n\n```shell script\n# Help\npython3 -m letterbomb -h\n\n# To include BootMii\npython3 -m letterbomb mac_address region -b\n\n# To enable logging debug\npython3 -m letterbomb mac_address region -g debug\n\n# To use a file for logging output\npython3 -m letterbomb mac_address region -l logfile.txt\n\n# To stream bytes instead, include BootMii\npython3 -m letterbomb mac_address region -b -i\n\n# To stream bytes instead, useful for piping\npython3 -m letterbomb mac_address region -i\n```\n\n## Documentation\n\n**Most casual users should refer to the [ReadTheDocs page](https://letterbomb.rtfd.io).**\n\nSome may want to build the documentation manually. To do this:\n\n```shell script\ngit clone https://gitlab.com/whoatemybutter/letterbomb.git\ncd letterbomb/docs\nmake html\nxdg-open _build/html/index.html\n```\n\nIf you prefer one-liners, there is one below:\n\n```shell script\ngit clone https://gitlab.com/whoatemybutter/letterbomb.git && cd letterbomb/docs && make html && xdg-open _build/html/index.html\n```\n\nBefore re-building the documentation, you should also run `make clean` to prevent stale files from remaining in newer builds.\n\nTo read about the exploit itself in more detail, please [read this article](https://wiibrew.org/wiki/LetterBomb).\n\n## Original source code\n\n* The *original* source code can be found at https://github.com/fail0verflow/letterbomb.\n* The *original* website can be found at https://please.hackmii.com.\n\n**Note:** *Original code likely will not work out-of-the-box.*\n\n## License\n\nLetterbomb is licensed under [GPLv3+](https://www.gnu.org/licenses/gpl-3.0.txt). ([included file](https://gitlab.com/whoatemybutter/letterbomb/-/raw/master/LICENSE.txt))\n\n\n",
"bugtrack_url": null,
"license": "GPLv3+",
"summary": "A fork of the classic Wii hacking tool from fail0verflow",
"version": "3.2.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "0697358ded636783b411bd1ff547401c",
"sha256": "3ada34b5ad8793cfe4bf53d36801d4788a1f138284f8123190d0ecd7c36c67f8"
},
"downloads": -1,
"filename": "letterbomb-3.2.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0697358ded636783b411bd1ff547401c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4726992,
"upload_time": "2020-11-25T17:58:02",
"upload_time_iso_8601": "2020-11-25T17:58:02.742435Z",
"url": "https://files.pythonhosted.org/packages/df/33/156d5d0b401c8e944c7ea898094e0a2e048ad6fd13bfff08ec1edd551927/letterbomb-3.2.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "665529ff6b2b7829187bdf032fb90f70",
"sha256": "8afdcbd31593bbf0f182af1e42eef39612308b1774808ac67d6f6f17e09ca5a2"
},
"downloads": -1,
"filename": "letterbomb-3.2.0.tar.gz",
"has_sig": false,
"md5_digest": "665529ff6b2b7829187bdf032fb90f70",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4716854,
"upload_time": "2020-11-25T17:58:04",
"upload_time_iso_8601": "2020-11-25T17:58:04.007087Z",
"url": "https://files.pythonhosted.org/packages/3a/69/7ea2105d51589da51ce27560ebc009587aa1c6e4b74ffe9c2df3c4914e86/letterbomb-3.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2020-11-25 17:58:04",
"github": false,
"gitlab": true,
"bitbucket": false,
"gitlab_user": null,
"gitlab_project": "whoatemybutter",
"lcname": "letterbomb"
}
JSON