Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
UTDZac authored Feb 17, 2023
1 parent 085e2fd commit c25627a
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,29 @@
# ImAttached-IronmonExtension
This simple extension adds an "I'm attached!" button, to let you and any viewers know that you are attached to your Pokémon.


## I'm Attached! Gen 3 Ironmon-Tracker Extension by UTDZac
![image](https://user-images.githubusercontent.com/4258818/219527367-f6a8af85-e5e1-4d39-9213-0fdfd444b850.png)

## Requirements:
- [Ironmon-Tracker v7.3.1](https://github.com/besteon/Ironmon-Tracker) or higher

## Install:
1) Download the [latest release](https://github.com/UTDZac/ImAttached-IronmonExtension/releases/latest) of this extension from the GitHub's Releases page
2) Extract the contents of the `.zip` file into a new folder
3) Copy all files & folders from the extracted folder into the "**extensions**" folder found inside your Tracker folder
- The file(s) should appear as: `[YOUR_TRACKER_FOLDER]/extensions/ImAttachedExtension.lua`

## Enable the Extension:
1) On the Tracker settings menu (click the gear icon on the Tracker window), click the "**Extensions**" button
2) In the Extensions menu, enable "**Allow custom code to run**" (if it is currently disabled)
3) Click the "**Refresh**" button at the bottom to check for newly installed extensions
- If you don't see anything in the extensions list, double-check the extension files are installed in the right location. Refer to the Tracker wiki documentation (at the bottom) if you need additional help
4) Click on the "**I'm Attached**" extension button to view the extension
5) From here, you can turn it on or off, as well as check for updates

## Usage:
- While enabled, this extension adds a little heart icon on the main Tracker screen for your Pokémon.
- Clicking this heart icon will color it in, indicating that you're "attached" to this Pokémon. Click it again to turn it off.
- An "attached" Pokémon doesn't do anything special, but rather just a fun little indicator that you really like this Pokémon.

## Custom Extensions Wiki:
https://github.com/besteon/Ironmon-Tracker/wiki/Tracker-Add-ons#custom-code-extensions

0 comments on commit c25627a

Please sign in to comment.