Skip to content

Leridon/cluetrainer

Repository files navigation


Clue Trainer

An interactive guide and assistant for clue scrolls in RuneScape 3.
Web Version and Installation · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Contributing
  4. Support
  5. License
  6. Contact
  7. Acknowledgments

About The Project

Product Name Screen Shot

Clue Trainer – The Ultimate Clue Solver for RuneScape 3

Clue Trainer is a powerful and highly configurable clue-solving plugin for RuneScape 3, designed for both newcomers and veteran clue chasers. Built for use with the Alt1 Toolkit, it enhances the clue-solving experience with interactive overlays, optimized movement strategies, and real-time puzzle assistance. Developed by a Clue Chaser for Clue Chasers, Clue Trainer has grown into a trusted tool with over a thousand daily users since its original release as Scan Trainer in 2023.

Key Features

  • Upgraded Puzzle Solver – Provides real-time move overlays, allowing you to solve puzzles at your own pace.
  • Included Path Guidance – Displays movement instructions on the map to help you learn the most efficient routes.
  • Advanced Scan Clue Strategies – Interactive, easy-to-memorize decision trees for solving scan clues faster.
  • Interactive Overlays – A new way to engage with Alt1 plugins.
  • Highly Accurate Compass Solver – Features reusable triangulation strategies, eliminating the need for manual teleport selection or struggling with minimap tracking.
  • Customizable Path & Method Editor – Create, save, and share your own clue-solving techniques.
  • Integrated Wiki (Cluepedia) – A built-in knowledge base explaining clue mechanics and Clue Trainer features.
  • Crowdsourced Clue Research – Participate in projects that expand our understanding of clue scrolls.
  • Extensive Configuration Options – Tailor Clue Trainer to fit your personal playstyle and preferences.

Visit cluetrainer.app to either explore its web features or to install it for the Alt1 Toolkit to enhance your RuneScape 3 clue-solving experience.

(back to top)

Getting Started

As a User

  1. Make sure you have the Alt1 toolkit installed. Alt1 can only be downloaded legitimately from runeapps.org.
  2. Visit the Web Version to access some of Clue Trainer's features or install it using the links provided there.
  3. Alternatively, open alt1://addapp/https://cluetrainer.app/appconfig.json in your browser or visit https://cluetrainer.app in Alt1's included browser.

(back to top)

As a Developer

Clue Trainer is a static website built using npm and TypeScript.

  1. Install dependencies using npm.
    npm install
  2. Build the project into the dist folder
    npm run build
  3. Serve the static content using a local webserver so it can be accessed in a browser or installed in Alt1. This is also available as a convenience in the script file serve_for_alt1.sh.
    cd dist
    python3 -m http.server 8000 --bind 127.0.0.1
  4. Visit 127.0.0.1:8000 in your browser to use your local version and install it in your local Alt1

Please do not enable any crowdsourcing options while using your local development version.

Contributing

Contributions to Clue Trainer in the form of either features or content are highly welcome. Even if you don't code, you can contribute new methods or Cluepedia articles in whatever form you would like and I will transfer it to the required format.

Check out Getting Started to see how to set up the project locally, so you can start coding. If you are serious about contributing a feature to Clue Trainer, please get into touch as described here to discuss the details before spending a large amount of effort.

(back to top)

Support and Feedback

You can get support, report issues, request features, or leave praise or criticism by joining the Clue Chasers Discord and entering the #clue-trainer channel. For support, issues and feature requests you can also create an issue.

(back to top)

License

Contents of this project are partially distributed under the MIT License. See LICENSE.md to see details and which files this applies to.

(back to top)

Contact

Zyklop Marco - @zyklopmarco

Project Link: https://github.com/leridon/cluetrainer

(back to top)

Acknowledgments

I owe thanks to the following persons for making Clue Trainer possible.

  • Skillbert for creating Alt1 in the first place and especially for allowing me to use code and data from the official clue solver, as well as for providing high quality map data for the world map.
  • Contributors from the Clue Chasers discord for providing knowledge about clues, and specifically Ngis for contributing most of the builtin methods to Clue Trainer.

(back to top)

About

Clue Trainer: A new RuneScape 3 clue solving tool for the Alt 1 toolkit.

Resources

License

Stars

Watchers

Forks

Sponsor this project

Languages