Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add install instructions #18

Open
FeldrinH opened this issue May 30, 2023 · 1 comment
Open

Add install instructions #18

FeldrinH opened this issue May 30, 2023 · 1 comment

Comments

@FeldrinH
Copy link

It would be nice to have explicit install instruction.
(If I understand it correctly then the intended way to install this package is to do npm install https://github.com/floh22/native-farsight-module, but it would be nice if this was explicitly stated somewhere.)

@Sylicium
Copy link

Unfortunatly, npm install https://github.com/floh22/native-farsight-module is not working on my end, so here's how worked around.

How to use

  1. Download zip of project (i personally used main branch)
  2. Start a League Of Legends match
  3. From the <root>/index.js call the connectToLeague() function.
    When its connected, you should be able to use makeSnapshot() to retrieve datas from the game.
    Make it in a loop so you have constant updated datas and enjoy !

Warning

If you're restarting too much the program, you could have an error when setting offsets, it is caused by a ratelimit of the offsetRepository url (/index.js:10).
To prevent that you can fetch that url one time and save the response for callback when ratelimited when debugging only not in production, since as written in README.md, this url MUST be called to maintain up to date the offsets. So be careful not to only use a prefetched version.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants