# ✉️💣 LetterBomb
<div align="center">
<h3>A fork of the classic Wii hacking tool from <a href="https://github.com/fail0verflow">fail0verflow</a>.</h3>
[](https://gitlab.com/whoatemybutter/letterbomb/-/pipelines)
[](https://pypi.org/project/letterbomb)
[](https://github.com/psf/black)
[](https://pylint.pycqa.org/en/latest/)
[](https://spdx.org/licenses/MIT.html)
[](https://pypi.org/project/letterbomb/)
[](https://gitlab.com/whoatemybutter/mcfonts/-/releases)
<a href="https://gitlab.com/whoatemybutter/letterbomb"><img src="assets/upscaled.png" width="250" align="center"/></a>
</div>
---
## Table of Contents
- [Installation](#installation)
- [PyPi](#pypi-recommended)
- [Manual](#manual-web-server-development)
- [Improvements](#improvements-over-original)
- [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: **(web server, development)**
```shell script
git clone https://gitlab.com/whoatemybutter/letterbomb.git
cd letterbomb
python -m build
```
## Improvements over original
| | *WhoAteMyButter's* | fail0verflow's |
|----------------|----------------------|-------------------------|
| Networking | Optional | Required |
| CLI | Yes | No |
| OS support | Linux, Windows, Mac | Linux |
| Logging | Yes | Yes, dependent on Flask |
| API | Yes | No |
| 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.10+ | 2.7 only |
| License | MIT | MIT |
| Documentation | Yes | No |
## Usage
#### Python
```python
import letterbomb
# Write to file, include HackMii:
letterbomb.write(mac="mac address", region="region letter", output_file="letterbomb.zip")
# Write to file, exclude HackMii:
letterbomb.write(mac="mac address", region="region letter", pack_bundle=False, output_file="letterbomb.zip")
# Write to stream, include HackMii:
letterbomb.write(mac="mac address", region="region letter")
# Write to stream, exclude HackMii:
letterbomb.write(mac="mac address", region="region letter", pack_bundle=False)
# To log debug messages
letterbomb.LOGGING_LEVEL = letterbomb.logging.DEBUG
# To log output to a file
letterbomb.LOGGING_FILE = "log.txt"
```
#### CLI
```shell
# Help
python3 -m letterbomb -h
# To include HackMii, output and create a ZIP
python3 -m letterbomb MAC REGION -b -o output.zip
# To enable debug logging
python3 -m letterbomb MAC REGION -g debug -o output.zip
# To use a file for logging output instead
python3 -m letterbomb MAC REGION -l logfile.txt -o output.zip
# To stream bytes instead, and include HackMii (-b)
python3 -m letterbomb MAC REGION -b
# To stream bytes instead, and exclude HackMii
python3 -m letterbomb MAC REGION
```
#### Web service
```shell script
git clone https://gitlab.com/whoatemybutter/letterbomb.git
cd letterbomb/web
python -m flask run
```
Obtaining a copy of `letterbomb` through PyPI will not have the web service included.
## 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 the [MIT liense](https://mit-license.org/). ([included file](https://gitlab.com/whoatemybutter/letterbomb/-/raw/master/LICENSE.txt))
Raw data
{
"_id": null,
"home_page": "",
"name": "letterbomb",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "letterbomb,letter bomb,wii,failoverflow,fail0verflow,fail overflow,fail 0verflow,exploit,wii hack,hacking,jailbreak,jailbreaking",
"author": "WhoAteMyButter",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/76/c3/7d6df2728a6950b7061b908baaad3f8afc17eec3939fde60fb7a616694a3/letterbomb-4.0.tar.gz",
"platform": null,
"description": "# \u2709\ufe0f\ud83d\udca3 LetterBomb\n\n<div 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[](https://gitlab.com/whoatemybutter/letterbomb/-/pipelines)\n[](https://pypi.org/project/letterbomb)\n[](https://github.com/psf/black)\n[](https://pylint.pycqa.org/en/latest/)\n[](https://spdx.org/licenses/MIT.html)\n[](https://pypi.org/project/letterbomb/)\n[](https://gitlab.com/whoatemybutter/mcfonts/-/releases)\n\n<a href=\"https://gitlab.com/whoatemybutter/letterbomb\"><img src=\"assets/upscaled.png\" width=\"250\" align=\"center\"/></a>\n\n</div>\n\n---\n\n## Table of Contents\n\n- [Installation](#installation)\n - [PyPi](#pypi-recommended)\n - [Manual](#manual-web-server-development)\n- [Improvements](#improvements-over-original)\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: **(web server, development)**\n```shell script\ngit clone https://gitlab.com/whoatemybutter/letterbomb.git\ncd letterbomb\npython -m build\n```\n\n## Improvements over original\n\n| | *WhoAteMyButter's* | fail0verflow's |\n|----------------|----------------------|-------------------------|\n| Networking | Optional | Required |\n| CLI | Yes | No |\n| OS support | Linux, Windows, Mac | Linux |\n| Logging | Yes | Yes, dependent on Flask |\n| API | Yes | No |\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.10+ | 2.7 only |\n| License | MIT | MIT |\n| Documentation | Yes | No |\n\n## Usage\n\n#### Python\n\n```python\nimport letterbomb\n\n# Write to file, include HackMii:\nletterbomb.write(mac=\"mac address\", region=\"region letter\", output_file=\"letterbomb.zip\")\n# Write to file, exclude HackMii:\nletterbomb.write(mac=\"mac address\", region=\"region letter\", pack_bundle=False, output_file=\"letterbomb.zip\")\n\n# Write to stream, include HackMii:\nletterbomb.write(mac=\"mac address\", region=\"region letter\")\n# Write to stream, exclude HackMii:\nletterbomb.write(mac=\"mac address\", region=\"region letter\", pack_bundle=False)\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\n# Help\npython3 -m letterbomb -h\n\n# To include HackMii, output and create a ZIP\npython3 -m letterbomb MAC REGION -b -o output.zip\n\n# To enable debug logging\npython3 -m letterbomb MAC REGION -g debug -o output.zip\n\n# To use a file for logging output instead\npython3 -m letterbomb MAC REGION -l logfile.txt -o output.zip\n\n# To stream bytes instead, and include HackMii (-b)\npython3 -m letterbomb MAC REGION -b\n\n# To stream bytes instead, and exclude HackMii\npython3 -m letterbomb MAC REGION\n```\n\n#### Web service\n\n```shell script\ngit clone https://gitlab.com/whoatemybutter/letterbomb.git\ncd letterbomb/web\npython -m flask run\n```\n\nObtaining a copy of `letterbomb` through PyPI will not have the web service included.\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 the [MIT liense](https://mit-license.org/). ([included file](https://gitlab.com/whoatemybutter/letterbomb/-/raw/master/LICENSE.txt))\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A fork of the classic Wii hacking tool from fail0verflow",
"version": "4.0",
"project_urls": {
"Changelog": "https://gitlab.com/whoatemybutter/letterbomb/-/blob/master/CHANGELOG.md",
"Documentation": "https://letterbomb.readthedocs.io",
"Source": "https://gitlab.com/whoatemybutter/letterbomb"
},
"split_keywords": [
"letterbomb",
"letter bomb",
"wii",
"failoverflow",
"fail0verflow",
"fail overflow",
"fail 0verflow",
"exploit",
"wii hack",
"hacking",
"jailbreak",
"jailbreaking"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9dabeda74b5184ef7976e8c80dd01fd69c2aabede3279fb3eed982d363ec3f80",
"md5": "29af2478ba5330f250183fcaed79c31d",
"sha256": "6465341b4d4e253ed065568f0b861a45e04ee985789058a3d08b952e9af57afe"
},
"downloads": -1,
"filename": "letterbomb-4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "29af2478ba5330f250183fcaed79c31d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 4663256,
"upload_time": "2023-10-21T21:50:06",
"upload_time_iso_8601": "2023-10-21T21:50:06.697238Z",
"url": "https://files.pythonhosted.org/packages/9d/ab/eda74b5184ef7976e8c80dd01fd69c2aabede3279fb3eed982d363ec3f80/letterbomb-4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "76c37d6df2728a6950b7061b908baaad3f8afc17eec3939fde60fb7a616694a3",
"md5": "16bce4c53c1f2c4126dafccf5f6ca37d",
"sha256": "cdefcae6ee2112ba38176ed3ae38a998c06f2bfa196767deb45d3a8620f6e525"
},
"downloads": -1,
"filename": "letterbomb-4.0.tar.gz",
"has_sig": false,
"md5_digest": "16bce4c53c1f2c4126dafccf5f6ca37d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 4664128,
"upload_time": "2023-10-21T21:50:08",
"upload_time_iso_8601": "2023-10-21T21:50:08.947768Z",
"url": "https://files.pythonhosted.org/packages/76/c3/7d6df2728a6950b7061b908baaad3f8afc17eec3939fde60fb7a616694a3/letterbomb-4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-21 21:50:08",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "whoatemybutter",
"gitlab_project": "letterbomb",
"lcname": "letterbomb"
}
JSON