-
-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2 from imLinguin/hgrid_type
add horizontal grid type
- Loading branch information
Showing
3 changed files
with
59 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
# steamgrid-proxy | ||
|
||
## Building | ||
Assuming you have `go` installed, run following command in root directory of the project | ||
|
||
``` | ||
go build | ||
``` | ||
|
||
Setup config.json file | ||
|
||
``` | ||
cp config/config.example.json config/config.json | ||
``` | ||
|
||
Modify `config/config.json` accordingly | ||
You can generate API key [here](https://www.steamgriddb.com/profile/preferences/api) | ||
|
||
Image URLs are cached in `cache` directory in subdirectories based on image type | ||
|
||
Run the server | ||
|
||
``` | ||
./steamgrid-proxy | ||
``` | ||
|
||
## API | ||
|
||
``` | ||
/api/search/GAME TITLE/IMAGE_TYPE | ||
``` | ||
|
||
`GAME TITLE` - title of a game you are looking for | ||
`IMAGE_TYPE` - (optional default - grids) | ||
|
||
|
||
## Supported image types | ||
|
||
- grids | ||
- hgrids | ||
- heroes | ||
- logos | ||
- icons |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters