Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohd-akram/item.tf
A website for finding and getting TF2 items through various methods
https://github.com/mohd-akram/item.tf
tf2 website
Last synced: 2 months ago
JSON representation
A website for finding and getting TF2 items through various methods
- Host: GitHub
- URL: https://github.com/mohd-akram/item.tf
- Owner: mohd-akram
- License: mit
- Created: 2012-07-04T22:36:46.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-06-19T09:28:00.000Z (6 months ago)
- Last Synced: 2024-06-19T18:58:58.732Z (6 months ago)
- Topics: tf2, website
- Language: Python
- Homepage: https://item.tf
- Size: 2.42 MB
- Stars: 12
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
item.tf
=======
This is a BlackSheep site that lets you search TF2 items and find the ones you
want. There are two main ways to search - you can either use regular keyword
search or search by classes and item tags (eg. weapon, misc, hat, etc.). Once
you find an item you want, you can get all kinds of information about it such
as its store price, market price and crafting recipes to help you obtain it.
You can also search for item sets or view a list of them by typing 'sets'.
Get Started
-----------
Copy config.default.py to config.py and fill in your API keys in the file.
Run this command to install dependencies.
pip install -r requirements.txt
You'll also need to install the [Valkey server](https://valkey.io).
Run updatestore.py to update the Valkey cache. Then, run `uvicorn main:app`.
Hosting
-------
To host the site in FreeBSD 14, first clone into `/usr/local/www/item.tf`.
Then, run the following as root:
pkg install -y nginx python311 valkey
mkdir -p /usr/local/etc/rc.conf.d
echo 'nginx_enable="YES"' > /usr/local/etc/rc.conf.d/nginx
echo 'valkey_enable="YES"' > /usr/local/etc/rc.conf.d/valkey
cd /usr/local/www/item.tf
make install
Make sure you set the `ssl_certificate` and `ssl_certificate_key` directives
and have `include conf.d/item.tf.conf;` at the end of the `http` block in
`/usr/local/etc/nginx/nginx.conf`.
Structure
---------
There are three main files:
* main.py - Contains the page handlers
* tf2api.py - Contains the main functions for getting items, store prices,
market prices and other information.
* tf2search.py - Contains the parsing and search functions.
TF2 API
-------
tf2api.py (depends on aiohttp) was designed to be used either for this project
or separately. It contains many helpful functions to get information about
items in TF2.
Example:
```python
import sys
import asyncio
import tf2api
async def main():
apikey = sys.argv[1]
schema = await tf2api.getschema(apikey)
items = tf2api.getitems(schema)
itemsbyname = tf2api.getitemsbyname(schema)
pan = items[264] # 264 is the defindex of the item, Or:
pan = itemsbyname['Frying Pan']
print(tf2api.getitemclasses(pan))
# ['Scout', 'Soldier', 'Pyro', 'Demoman', 'Heavy', 'Medic', 'Sniper']
print(tf2api.getitemtags(pan))
# ['weapon', 'melee']
asyncio.get_event_loop().run_until_complete(main())
```
Thanks
------
This project was inspired by and depends on the great TF2 community to
function, so a special thanks to the following:
[Backpack.tf](https://backpack.tf)
[TF2 Crafting Advisor](https://www.tf2crafting.info)
[TF2B](https://tf2b.com)