https://github.com/igeligel/skadisteaminventoryproxy
:whale: Docker Container to request Steam Inventories via a .NET Core Web API with easy Proxy Support
https://github.com/igeligel/skadisteaminventoryproxy
asp-net-core aspnetcore docker docker-container steam steam-api steam-community steam-inventory steam-market steam-trading steambot
Last synced: 3 months ago
JSON representation
:whale: Docker Container to request Steam Inventories via a .NET Core Web API with easy Proxy Support
- Host: GitHub
- URL: https://github.com/igeligel/skadisteaminventoryproxy
- Owner: igeligel
- License: mit
- Created: 2017-05-14T20:10:15.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2017-05-15T20:28:21.000Z (over 8 years ago)
- Last Synced: 2025-01-20T11:43:34.125Z (9 months ago)
- Topics: asp-net-core, aspnetcore, docker, docker-container, steam, steam-api, steam-community, steam-inventory, steam-market, steam-trading, steambot
- Language: C#
- Homepage:
- Size: 11.7 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: license.md
Awesome Lists containing this project
README
# SkadisteamInventoryProxy by igeligel
## Description
> A [.NET Core](https://www.microsoft.com/net/core) Project within a [Docker](https://www.docker.com/) Container to make it possible to easily host a Proxy Service for [Steam Community](http://steamcommunity.com/) Inventory Requests. It has an integrated In-Memory-Cache which is configurable via the settings file.
## Installation
First clone the repository:
```bash
git clone https://github.com/igeligel/SkadisteamInventoryProxy.git
cd SkadisteamInventoryProxy
```
Just run the command:
```bash
./build.sh
```
If you dont have the possibility to run [Docker](https://www.docker.com/) you can run it as normal [ASP.NET Core](https://docs.microsoft.com/en-us/aspnet/core/) Web Application:
```bash
cd src
dotnet restore
dotnet publish -c Release -o out
cd out
dotnet SkadisteamInventoryProxy.dll
```
For development:
```bash
cd src
dotnet restore
dotnet build
dotnet run
```
## How To Use
In the [source code](https://github.com/igeligel/SkadisteamInventoryProxy/tree/master/src) of this repository you can find a file called [appsettings.inventory.json](https://github.com/igeligel/SkadisteamInventoryProxy/blob/master/src/appsettings.inventory.json).
You can set different configurations inside this file. For more documentations check out the docs folder.
After you have applied the settings you can start the application and go to: [localhost:5000/api/inventory/76561198028630048/730/2](http://localhost:5000/api/inventory/{steamCommunityId}/{appId}/{contextId}).
The whole API is hosted on Port 5000. If you want to change this, change the Port inside [Program.cs](https://github.com/igeligel/SkadisteamInventoryProxy/blob/master/src/Program.cs#L16).
You can also change the Cache time. The Cache Time describes how long an inventory should be cached. You are also able to exclude several Steam Community Id's from Caching via the configuration file. To get examples of the check out the ``/docs`` [folder](https://github.com/igeligel/SkadisteamInventoryProxy/tree/master/docs).
To disable the In-Memory-Cache just set the time to ``0``.
## Examples
- [Hosted on Digital Ocean (No Production)](http://46.101.102.223/api/inventory/76561198028630048/730/2)
## Contributing
Feel free to contribute. Always check Issues first if something is requested.
## Resources
### Motivation
Since [Steam Community](http://steamcommunity.com/) is limiting requests to the [inventory endpoint](http://steamcommunity.com/inventory/76561198028630048/730/2?l=english&count=5000) heavily, i was forced to come up with a solution. Since it should be just an easy project you can just get up and running with [Docker](https://www.docker.com/) and configuring the settings file.
### Documentation
> You can find documentation [here](https://github.com/igeligel/SkadisteamInventoryProxy/tree/master/docs).
## Contact
Contributors
Contributions: 4
## License
*SkadisteamInventoryProxy* is realeased under the MIT License.
## This readme is powered by vue-readme
Check out vue-readme [[Website](https://igeligel.github.io/vue-readme) | [GitHub](https://github.com/igeligel/vue-readme)]
