-# Minimal Alt1/webpack/typescript example
+# Slayer Assistant for Alt1
-how to use
-```sh
-# to initialize the repo and install dependencies
-npm i
-# build
-npm run build
-# alternatively to auto-rebuild when source files are changed
-npm run watch
-```
+Slayer Assistant for Alt1 is a dynamic tool for RuneScape players, designed to enhance the Slayer experience with a variety of useful features. It provides an intuitive user interface, customizable settings, and integration with Alt1 Toolkit. This app aims to streamline Slayer and Reaper tasks, improve task searching, and offer other enhancements to make the Slayer experience more enjoyable.
-You can open `./dist/index.html` in your browser and it will give some basic functionality based one pasted images.
+## Features
-You can also open it in the Alt1 browser and click the `add app` button that appears to get some basic alt1 functionality.
\ No newline at end of file
+- **Dynamic Settings System**: Modify your preferences directly within the app for easy customization and instant updates.
+- **Customizable UI**: Change themes and settings without needing to refresh or use additional CSS files.
+- **Hidden Creatures**: Hide creatures from the interface for a more personalized view.
+- **Import/Export Settings**: Import and export your settings for easy transfer across devices.
+- **Reaper & Slayer Task Enhancements**: Improved task searching and counter lookups for Slayer and Reaper tasks.
+- **Database Integration**: Uses data from the RuneScape Wiki and other sources to keep the app up-to-date.
+- **Search Optimization**: Levenshtein distance algorithm for faster and more accurate search results.
+
+## Installation
+
+Visti https://slayer.unlishema.org or click [here](alt1://addapp/https://slayer.unlishema.org/appconfig.json) to add the app to alt1
+
+## Usage
+
+- **Settings**: Modify your app preferences using the "Settings" menu. You can enable or disable certain features and tweak the look and feel to suit your preferences.
+- **Task Searching**: Use the search bar to quickly find specific Slayer or Reaper tasks.
+- **Hidden Creatures**: You can choose to hide specific creatures from the interface for a cleaner view.
+
+## Credits
+
+### Assistance with Slayer Assistant for Alt1
+- [codedninja](https://runeapps.org/forums/viewtopic.php?id=570) - For creating the original app and inspiring the look and feel of this app
+- [Skillbert](https://discordapp.com/users/Skillbert#9582) - For all the assistance during the creation of this app, as well as for creating Alt1 Toolkit
+- [Zykrow](https://discordapp.com/users/Zykrow#8009) - For support and assistance during the entire development of this app
+- [crazye97](https://discordapp.com/users/crazye97#2027) - For all the assistance during the development of this app, too much to specify each one
+- [troy236](https://discordapp.com/users/troy236#2361) - For giving me the answer to why I couldn't edit the src of an img in JavaScript
+- [Emma Kitty](https://discordapp.com/users/Emma%20Kitty#6969) - For helping manage the database; formatting, adding manual entries, and adding user experience content to the app
+- [Annie the Eagle](https://discordapp.com/users/Annie%20the%20Eagle#0001) - For help with adjusting the Look and Feel of the app
+- [MrSlayerGod](https://discordapp.com/users/MrSlayerGod#5656) - For suggestions on the newest Look and Feel of the app
+- [Poop Skewer](https://discordapp.com/users/Poop%20Skewer#7325) - For suggesting moving the app over to GitHub for better uptime
+- [display_this](https://discordapp.com/users/vinay#5636) - For reporting app-breaking bugs that kept the app from running at its full potential
+- [Leridon](https://discordapp.com/users/Leridon#6812) - For assisting with the Slayer/Reaper counter lookup and helping fix major issues during the upgrade of Alt1 source
+- [Nex ex Umbra](https://discordapp.com/users/Umbra#5689) - For assistance on getting the Select Your Own Task detection to work
+- [Ex Inferi](https://discordapp.com/users/Inferi#6666) - For creating the drop-down for the search bar so it works with Alt1 and not just normal browsers, and for all the support during development
+- [Techpure](https://discordapp.com/users/Techpure#3254) - For supporting the development of the app and suggesting the ability to change colors in the app
+- [overlord1234 & David](https://stackoverflow.com/questions/10473745/compare-strings-javascript-return-of-likely) - For the Levenshtein distance algorithm for the search feature
+
+### Assistance with Slayer Assistant Database Updater
+- [Runescape Wiki](https://runescape.wiki) - For providing an amazing database that I can parse to make use of in this app
+- [Chiev Hunter](https://discordapp.com/users/achievementshunter) - For assistance in fixing the Slayer assignment wiki so my updater would stop throwing errors
+- [Wahi](https://discordapp.com/users/Wahi#5030) - For explaining the Wights task was old content that was removed
+- [Robert571](https://discordapp.com/users/Robert571#7543) - For suggesting the new query search for database downloading from the wiki
+- [Im Wired In](https://discordapp.com/users/Wired%20In#2593) - For all the assistance in helping figure out how to use the new query search for database downloading from the wiki
+
+### For Creating Something Amazing
+- [Jagex](http://jagex.com) - For creating an amazing game that has many more years to come
+- [Runescape](http://runescape.com) - For still being here after all these years and coming a long way
+- [Runescape Wiki](https://runescape.wiki) - For providing an amazing database for all of the RuneScape community
+- [Chat GPT](https://chat.openai.com) - For creating something amazing that can assist with anything
+- [Skillbert](https://discordapp.com/users/Skillbert#9582) - For creating Alt1 Toolkit and keeping it maintained
projects / slayer.unlishema.org / .git / commitdiff