Skip to content

Commit 8ec9efd

Browse files
committed
Naming changed according to Flipper Zero App catalogue moderators
1 parent 52119c6 commit 8ec9efd

2 files changed

Lines changed: 21 additions & 21 deletions

File tree

README.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
# Flippper Amiibo Toolkit
1+
# AmiTool
22

3-
An Amiibo toolkit app for Flipper Zero.
3+
An Flipper Zero toolkit to work with NTAG215 tags with gaming consoles.
44

5-
This project is usable but still in development. Ensure you back up all important data and avoid using it with another experimental setup, like Amiibo Link writing, to prevent damage or data loss.
5+
This project is usable but still in development. Ensure you back up all important data and avoid using it with another experimental setup to prevent damage or data loss.
66

77
## Features
88

9-
Designed as a general-purpose Amiibo toolkit for Flipper Zero, this app aims to provide the following features:
9+
Designed as a general-purpose toolkit for Flipper Zero to work with NTAG215 figures/cards for gaming consoles, this app aims to provide the following features:
1010

11-
- **Reading Amiibo NFC tags**: Read data from physical Amiibo NFC tags and store it on the Flipper Zero.
12-
- **Displaying Amiibo information**: Show detailed information about the Amiibo, including character name, series, type, usage, and other metadata. This information is sourced from the AmiiboAPI (https://amiiboapi.com/).
13-
- **Emulating Amiibo NFC tags**: Emulate the loaded Amiibo data, allowing the Flipper Zero to function as the corresponding Amiibo NFC tag.
14-
- **Writing Amiibo data to NFC tags**: Write currently loaded Amiibo data to blank NTAG 215 tags compatible with Amiibo.
15-
- **Generating Amiibo data**: Create a synthetic Amiibo data structure based on selected character. The result would be a blank Amiibo data file that can be written to a blank NTAG 215 tag.
16-
- **Randomising the unique identifier (UID)**: Modify the UID of the loaded Amiibo data to a random valid value, allowing one tag to be used as multiple different Amiibo.
11+
- **Reading NTAG215 character NFC tags**: Read data from physical NTAG215 gaming tags and store it on the Flipper Zero.
12+
- **Displaying character information**: Show detailed information about the tag, including character name, series, type, usage, and other metadata. This information is sourced from the AmiiboAPI (https://amiiboapi.com/).
13+
- **Emulating NTAG215 gaming NFC tags**: Emulate the loaded data, allowing the Flipper Zero to function as the corresponding character tag.
14+
- **Writing game data to NFC tags**: Write currently loaded tag data to blank NTAG 215 tags, or a compatible device.
15+
- **Generating character data**: Create a synthetic character data structure based on selected character. The result would be a blank data file that can be written to a blank NTAG 215 tag, with no owner or game information.
16+
- **Randomising the unique identifier (UID)**: Modify the UID of the loaded character data to a random valid value, allowing one tag to be used as multiple different tags.
1717
- **Emulating a blank tag**: Emulate a blank NTAG 215 tag that can be written into with other devices.
18-
- **Saving and loading Amiibo data files**: Store generated or read Amiibo data files on the Flipper Zero's storage for later use.
18+
- **Saving and loading character data files**: Store generated or read data files on the Flipper Zero's storage for later use.
1919

2020
And other combinations of the above features.
2121

@@ -29,7 +29,7 @@ This app is not yet available in the official Flipper Zero app store. Instead, y
2929

3030
## Usage
3131

32-
To use the generation and UID randomisation features, you will need to have a `key_retail.bin` file available in the app data directory (`/apps_data/ami_tool`). This file contains the necessary cryptographic keys to encrypt/decrypt and sign Amiibo data. It is legally Nintendo's intellectual property, and cannot be distributed with this project. You will need to obtain it yourself, for example by dumping it from a console you own that supports Amiibo functionality, or by finding it from other sources. We will not provide instructions on how to obtain this file, as doing so may violate Nintendo's terms of service or local laws.
32+
To use the generation and UID randomisation features, you will need to have a `key_retail.bin` file available in the app data directory (`/apps_data/ami_tool`). This file contains the necessary cryptographic keys to encrypt/decrypt and sign character data. It is legally Nintendo's intellectual property, and cannot be distributed with this project. You will need to obtain it yourself, for example by dumping it from a console you own that supports such functionality, or by finding it from other sources. We will not provide instructions on how to obtain this file, as doing so may violate Nintendo's terms of service or local laws, but there are plenty of guides online.
3333

3434
Following are some screenshots of the app in action, all the steps of usage are guided within the app itself.
3535

@@ -81,17 +81,17 @@ Following are some screenshots of the app in action, all the steps of usage are
8181

8282
- Thanks to the Flipper Zero community and developers for their continuous support and inspiration.
8383
- The data used in this project comes from AmiiboAPI (https://amiiboapi.com/).
84-
- The algorighms and methods for Amiibo data manipulation are based on research and contributions from various online communities dedicated to Amiibo reverse engineering. Including but not limited to:
85-
* [Reverse Engineering Nintendo Amiibo (NFC Toy)](https://kevinbrewster.github.io/Amiibo-Reverse-Engineering/), containing a very detailed analysis of the Amiibo data structure.
86-
* [amiitool](https://github.com/socram8888/amiitool), a command-line tool for manipulating Amiibo data.
87-
* [weebo](https://github.com/bettse/weebo), another flipper zero amiibo tool, which uses amiitool, confirming (for me personally) that the flipper zero can handle the cryptography involved in Amiibo data manipulation.
84+
- The algorighms and methods for character data manipulation are based on research and contributions from various online communities dedicated to Amiibo reverse engineering. Including but not limited to:
85+
* [Reverse Engineering Nintendo Amiibo (NFC Toy)](https://kevinbrewster.github.io/Amiibo-Reverse-Engineering/), containing a very detailed analysis of the data structure.
86+
* [amiitool](https://github.com/socram8888/amiitool), a command-line tool for manipulating dumped data. Note that the data is in a different format of what this project uses, and it won't work with the data stored with this app.
87+
* [weebo](https://github.com/bettse/weebo), another flipper zero NTAG215 tool, which uses amiitool, confirming (for me personally) that the flipper zero can handle the cryptography involved in data manipulation.
8888

8989
## License and Disclaimer
9090

9191
This project and its source code is licensed under the GNU General Public License v3.0 (GPL-3.0). See the [LICENSE](LICENSE) file for details. By using this project, you agree to comply with the terms of the GPL-3.0 license.
9292

9393
The data files used in this project are sourced from AmiiboAPI (https://amiiboapi.com/), which is licensed under the [MIT License](https://github.com/N3evin/AmiiboAPI/blob/master/LICENSE). A copy of it is included in the files directory for inclusion in the release package.
9494

95-
This project is not affiliated with or endorsed by Nintendo, AmiiboAPI, or any other tools or libraries used or mentioned herein. The developers of this project do not encourage or condone the use of this project for any illegal activities, including but not limited to copyright infringement or unauthorized duplication of Amiibo data. This project is intended for educational, research, and personal use only. Users are responsible for ensuring that their use of this project complies with all applicable laws and regulations.
95+
This project is not affiliated with or endorsed by Nintendo, AmiiboAPI, or any other tools or libraries used or mentioned herein. The developers of this project do not encourage or condone the use of this project for any illegal activities, including but not limited to copyright infringement or unauthorized duplication of proprietary data. This project is intended for educational, research, and personal use only. Users are responsible for ensuring that their use of this project complies with all applicable laws and regulations.
9696

9797
In some jurisdictions, the use of radio equipment like the Flipper Zero may be subject to specific regulations. Users are responsible for ensuring that their use of the Flipper Zero and this project complies with all applicable laws and regulations in their jurisdiction.

application.fam

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
App(
22
appid="ami_tool",
3-
name="Amiibo Toolkit",
3+
name="AmiTool",
44
apptype=FlipperAppType.EXTERNAL,
55
entry_point="ami_tool_app",
66
requires=["gui"],
77
stack_size=2 * 1024,
88
fap_category="NFC",
99
fap_icon="ami_tool.png",
10-
fap_description="An Amiibo toolkit for Flipper Zero",
10+
fap_description="An NTAG215 toolkit for Flipper Zero to work with tags used with gaming consoles.",
1111
fap_author="Firefox2100",
12-
fap_weburl="https://github.com/Firefox2100/flipper-amiibo-toolkit",
12+
fap_weburl="https://github.com/Firefox2100/ami-tool",
1313
fap_file_assets="files",
1414
fap_libs=["mbedtls"],
15-
fap_version="0.2.0",
15+
fap_version="0.2.1",
1616
)

0 commit comments

Comments
 (0)