You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-17Lines changed: 17 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,21 +1,21 @@
1
-
# Flippper Amiibo Toolkit
1
+
# AmiTool
2
2
3
-
An Amiibo toolkit app for Flipper Zero.
3
+
An Flipper Zero toolkit to work with NTAG215 tags with gaming consoles.
4
4
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.
6
6
7
7
## Features
8
8
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:
10
10
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.
17
17
-**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.
19
19
20
20
And other combinations of the above features.
21
21
@@ -29,7 +29,7 @@ This app is not yet available in the official Flipper Zero app store. Instead, y
29
29
30
30
## Usage
31
31
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.
33
33
34
34
Following are some screenshots of the app in action, all the steps of usage are guided within the app itself.
35
35
@@ -81,17 +81,17 @@ Following are some screenshots of the app in action, all the steps of usage are
81
81
82
82
- Thanks to the Flipper Zero community and developers for their continuous support and inspiration.
83
83
- 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.
88
88
89
89
## License and Disclaimer
90
90
91
91
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.
92
92
93
93
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.
94
94
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.
96
96
97
97
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.
0 commit comments