Skip to content

Commit

Permalink
add support info to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
liamcottle committed Apr 26, 2022
1 parent afcf0cd commit dc80701
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,11 +225,11 @@ Below is a list of API calls that are implemented in this library.
- [x] `getPlayers(playerIds)`
- [x] `getStoryContractDefinitions()`
# Content API
## Content API
Check out the [Content API Docs](./docs/ContentAPI.md) if you're wanting to fetch game assets such as Maps, Player Cards and Weapons.
# Local Riot Client API
## Local Riot Client API
If you're looking for information on how to interact with `RiotClientServices.exe`, such as intercepting requests, take a look at the documentation in [RiotClientServices.md](./docs/RiotClientServices.md)
Expand All @@ -243,6 +243,21 @@ const localRiotClientApi = Valorant.LocalRiotClientAPI.initFromLockFile();
const localRiotClientApi = new Valorant.LocalRiotClientAPI('127.0.0.1', 'port', 'riot', 'yourtoken');`
```
## Support
- If you need any help, feel free to [Join the Discord](https://discord.gg/APQSQZNV7t).
- If you find a bug, feel free to open an issue or submit a pull request.
In some cases, you might receive an `HTTP 404` error when using some in-game APIs. It's likely that the `client_version` we are using is outdated.
You can find the latest `client_version` [here](https://valorant-api.com/v1/version) listed as `riotClientVersion` and you can manually set the `client_version` used in this library like so:
```
const Valorant = require('@liamcottle/valorant.js');
const valorantApi = new Valorant.API(Valorant.Regions.AsiaPacific);
valorantApi.client_version = "...";
```
## License
MIT
Expand Down

0 comments on commit dc80701

Please sign in to comment.