csgoinvshuffle 1.3.10
A package for creating CS:GO inventory shuffle config files
License: MIT
Requires Python: >=3.7,<4.0

# csgoinvshuffle

[![PyPI version](https://badge.fury.io/py/csgoinvshuffle.svg)](https://badge.fury.io/py/csgoinvshuffle)
[![GitHub license](https://img.shields.io/github/license/jvllmr/csgo-inv-shuffle)](https://github.com/kreyoo/csgo-inv-shuffle/blob/master/LICENSE)
[![GitHub issues](https://img.shields.io/github/issues/jvllmr/csgo-inv-shuffle)](https://github.com/kreyoo/csgo-inv-shuffle/issues)
![PyPI - Downloads](https://img.shields.io/pypi/dd/csgoinvshuffle)
![Tests](https://github.com/kreyoo/csgo-inv-shuffle/actions/workflows/main.yml/badge.svg)
![Codecov](https://img.shields.io/codecov/c/github/jvllmr/csgo-inv-shuffle?style=plastic)

# Description

csgoinvshuffle is a Python package designed to generate inventory shuffle config files for the game CS:GO.

With this package you can easily shuffle between different weapon types (e.g. M4A4 and M4A1-S) and have less limits in customizing the shuffle experience than with the in-game settings.

## Note:

CS:GO never really queues your items in a random order.
The items are arranged in one simple, predefined cycle.
This package aims to creating shuffles to your liking with ease

You can use the config file it creates and replace `<path_to_your_steam>/userdata/<your_steam_3id>/730/remote/cfg/csgo_saved_item_shuffles.txt` with it to apply your config.

#### HINT:

CS:GO needs to be closed while replacing the file

# How to install

`pip install csgoinvshuffle`

# Basic usage

## Your steam inventory needs to be public!

### Basic shuffle for everything in your inventory with randomness

```python
from csgoinvshuffle import ShuffleConfig, get_inventory

with ShuffleConfig() as sc:
    sc.add_items(get_inventory("YOUR_STEAM_ID_64"))
    sc.randomize()
```

### Give items a certain order in the cycle

```python
from csgoinvshuffle import ShuffleConfig, get_inventory
from csgoinvshuffle.enums import TagsInternalName

# This example only works if you have at least 4 music kits in your inventory
sc = ShuffleConfig()
inv = get_inventory("YOUR_STEAM_ID_64")
music_kits = inv.filter(TagsInternalName.MUSIC_KITS)
sc.set_item(0 , music_kits[3])
sc.set_item(1, music_kits[1])
sc.save()
```

As you can see in the last example, an inventory is equipped with a filter attribute and can be handled like a list.
You can filter for enums and the filter uses the TagsInternalName by default, as it is the most useful one.
Otherwise using the built-in filter() function on the Inventory Object is suggested.
To get an overview of what values the attributes of an Item can have, you can lookup https://steamcommunity.com/inventory/<YOUR_STEAM_ID_64>/730/2
or lookup the typing definitions inside the item class.
As mentioned, typical values for the property `tags_internal_name` are provided by the TagsInternalName enum.

### Create a shuffle cycle for only one team side

```python
from csgoinvshuffle import ShuffleConfig, get_inventory
from csgoinvshuffle.enums import TagsInternalName, TeamSide

with ShuffleConfig() as sc:
    inv = get_inventory("YOUR_STEAM_ID_64")
    knives = inv.filter(TagsInternalName.KNIVES)
    classic_knife = knives.filter(TagsInternalName.CLASSIC_KNIFE)[0]
    karambit = knives.filter(TagsInternalName.KARAMBIT_KNIFE)[0]
    butterfly = filter(lambda x: x.custom_name == "crypto is for n00bs", knives)[0]
    # First map karambit, second map classic knife, third map butterfly, next map karambit again...
    # On T side only
    my_shuffle_cycle = [karambit, classic_knife, butterfly]
    sc.add_items(my_shuffle_cycle, TeamSide.T)
```

By default, the attribute methods from `ShuffleConfig` do everything for both teams.
If you want to have different shuffle cycles on the opposing sides, you have to state it with a parameter.