Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Citrinate committed Jan 12, 2025
1 parent 0511cb5 commit 43620de
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 34 deletions.
2 changes: 1 addition & 1 deletion CS2Interface/IPC/Documentation/Data/Recipes.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Property | Type | Description
`Data.inputs` | `string` | A description of the inputs
`Data.outputs` | `string` | A description of the outputs
`Data.quality` | `string` | The quality of the inputs and outputs (Unique or StatTrak™)
`Data.def`| `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `recipes`
`Data.def`| `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `recipes`

## Example Response

Expand Down
14 changes: 7 additions & 7 deletions CS2Interface/IPC/Documentation/Items/GetCrateContents.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Property | Type | Description
`item_name` | `string` | The item's name
`tool_name` | `string` | What type of tool this is (usually the same as `type_name`, except for Sealed Graffiti)
`tint_name` | `string` | The item's tint
`weapon_image_url` | `string` | An image of the item (if one exists in [items_game_cdn.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md))
`weapon_image_url` | `string` | An image of the item (if one exists in [items_game_cdn.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md))
`weapon_name` | `string` | The weapon this applies to
`wear_name` | `string` | The name for the float range this item falls into
`wear` | `float` | The item's float value
Expand All @@ -48,13 +48,13 @@ Property | Type | Description
`set_name_id` | `string` | The unique string ID for the collection this item belongs to
`set_name` | `string` | The name of the collection this item belongs to
`crate_name_id` | `string` | The unique string ID for the crate this item can be found in
`crate_defindex` | `uint` | The definition index for the crate this item can be found in (the definition for which can be found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `items`)
`crate_defindex` | `uint` | The definition index for the crate this item can be found in (the definition for which can be found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `items`)
`crate_name` | `string` | The name of the crate this item can be found in
`defs.item_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `items`
`defs.paint_kit_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `paint_kits`
`defs.sticker_kit_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `sticker_kits`
`defs.music_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `music_definitions`
`defs.keychain_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `keychain_definitions`
`defs.item_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `items`
`defs.paint_kit_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `paint_kits`
`defs.sticker_kit_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `sticker_kits`
`defs.music_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `music_definitions`
`defs.keychain_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `keychain_definitions`

## Example Response

Expand Down
14 changes: 7 additions & 7 deletions CS2Interface/IPC/Documentation/Items/InspectItem.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Property | Type | Description
`item_name` | `string` | The item's name
`tool_name` | `string` | What type of tool this is (usually the same as `type_name`, except for Sealed Graffiti)
`tint_name` | `string` | The item's tint
`weapon_image_url` | `string` | An image of the item (if one exists in [items_game_cdn.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md))
`weapon_image_url` | `string` | An image of the item (if one exists in [items_game_cdn.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md))
`weapon_name` | `string` | The weapon this applies to
`wear_name` | `string` | The name for the float range this item falls into
`wear` | `float` | The item's float value
Expand All @@ -49,13 +49,13 @@ Property | Type | Description
`set_name_id` | `string` | The unique string ID for the collection this item belongs to
`set_name` | `string` | The name of the collection this item belongs to
`crate_name_id` | `string` | The unique string ID for the crate this item can be found in
`crate_defindex` | `uint` | The definition index for the crate this item can be found in (the definition for which can be found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `items`)
`crate_defindex` | `uint` | The definition index for the crate this item can be found in (the definition for which can be found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `items`)
`crate_name` | `string` | The name of the crate this item can be found in
`defs.item_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `items`
`defs.paint_kit_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `paint_kits`
`defs.sticker_kit_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `sticker_kits`
`defs.music_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `music_definitions`
`defs.keychain_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `keychain_definitions`
`defs.item_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `items`
`defs.paint_kit_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `paint_kits`
`defs.sticker_kit_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `sticker_kits`
`defs.music_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `music_definitions`
`defs.keychain_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `keychain_definitions`

## Example Responses

Expand Down
14 changes: 7 additions & 7 deletions CS2Interface/IPC/Documentation/Items/Inventory.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Property | Type | Description
`item_name` | `string` | The item's name
`tool_name` | `string` | What type of tool this is (usually the same as `type_name`, except for Sealed Graffiti)
`tint_name` | `string` | The item's tint
`weapon_image_url` | `string` | An image of the item (if one exists in [items_game_cdn.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md))
`weapon_image_url` | `string` | An image of the item (if one exists in [items_game_cdn.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md))
`weapon_name` | `string` | The weapon this applies to
`wear_name` | `string` | The name for the float range this item falls into
`wear` | `float` | The item's float value
Expand All @@ -46,13 +46,13 @@ Property | Type | Description
`set_name_id` | `string` | The unique string ID for the collection this item belongs to
`set_name` | `string` | The name of the collection this item belongs to
`crate_name_id` | `string` | The unique string ID for the crate this item can be found in
`crate_defindex` | `uint` | The definition index for the crate this item can be found in (the definition for which can be found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `items`)
`crate_defindex` | `uint` | The definition index for the crate this item can be found in (the definition for which can be found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `items`)
`crate_name` | `string` | The name of the crate this item can be found in
`defs.item_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `items`
`defs.paint_kit_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `paint_kits`
`defs.sticker_kit_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `sticker_kits`
`defs.music_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `music_definitions`
`defs.keychain_def` | `object` | Related game data found in [items_game.txt](CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `keychain_definitions`
`defs.item_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `items`
`defs.paint_kit_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `paint_kits`
`defs.sticker_kit_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `sticker_kits`
`defs.music_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `music_definitions`
`defs.keychain_def` | `object` | Related game data found in [items_game.txt](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md) under `keychain_definitions`

## Example Responses

Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,30 +59,30 @@ Command | Alias |

API | Method | Parameters | Description
--- | --- | --- | ---
[`/Api/CS2Interface/{botNames}/Start`](CS2Interface/IPC/Documentation/Interface/Start.md)|`GET`| |Starts the CS2 Interface
[`/Api/CS2Interface/{botNames}/Status`](CS2Interface/IPC/Documentation/Interface/Status.md)|`GET`| |Get the CS2 Interface status
[`/Api/CS2Interface/{botNames}/Stop`](CS2Interface/IPC/Documentation/Interface/Stop.md)|`GET`| |Stops the CS2 Interface
[`/Api/CS2Interface/{botNames}/Start`](/CS2Interface/IPC/Documentation/Interface/Start.md)|`GET`| |Starts the CS2 Interface
[`/Api/CS2Interface/{botNames}/Status`](/CS2Interface/IPC/Documentation/Interface/Status.md)|`GET`| |Get the CS2 Interface status
[`/Api/CS2Interface/{botNames}/Stop`](/CS2Interface/IPC/Documentation/Interface/Stop.md)|`GET`| |Stops the CS2 Interface

#### Items

API | Method | Parameters | Description
--- | --- | --- | ---
[`/Api/CS2Interface/{botName}/CraftItem/{recipeID}`](CS2Interface/IPC/Documentation/Items/CraftItem.md)|`GET`|`itemIDs`|Craft an item
[`/Api/CS2Interface/{botName}/GetCrateContents/{crateID}`](CS2Interface/IPC/Documentation/Items/GetCrateContents.md)|`GET`|`minimal`, `showDefs`|Get a storage unit's contents
[`/Api/CS2Interface/{botNames}/InspectItem`](CS2Interface/IPC/Documentation/Items/InspectItem.md)|`GET`|`url`, `s`, `a`, `d`, `m`, `minimal`, `showDefs`|Inspect an item
[`/Api/CS2Interface/{botName}/Inventory`](CS2Interface/IPC/Documentation/Items/Inventory.md)|`GET`|`minimal`, `showDefs`|Get a bot's inventory
[`/Api/CS2Interface/{botName}/RetrieveItem/{crateID}/{itemID}`](CS2Interface/IPC/Documentation/Items/RetrieveItem.md)|`GET`| |Take an item out of a storage unit
[`/Api/CS2Interface/{botName}/StoreItem/{crateID}/{itemID}`](CS2Interface/IPC/Documentation/Items/StoreItem.md)|`GET`| |Place an item into a storage unit
[`/Api/CS2Interface/{botName}/CraftItem/{recipeID}`](/CS2Interface/IPC/Documentation/Items/CraftItem.md)|`GET`|`itemIDs`|Craft an item
[`/Api/CS2Interface/{botName}/GetCrateContents/{crateID}`](/CS2Interface/IPC/Documentation/Items/GetCrateContents.md)|`GET`|`minimal`, `showDefs`|Get a storage unit's contents
[`/Api/CS2Interface/{botNames}/InspectItem`](/CS2Interface/IPC/Documentation/Items/InspectItem.md)|`GET`|`url`, `s`, `a`, `d`, `m`, `minimal`, `showDefs`|Inspect an item
[`/Api/CS2Interface/{botName}/Inventory`](/CS2Interface/IPC/Documentation/Items/Inventory.md)|`GET`|`minimal`, `showDefs`|Get a bot's inventory
[`/Api/CS2Interface/{botName}/RetrieveItem/{crateID}/{itemID}`](/CS2Interface/IPC/Documentation/Items/RetrieveItem.md)|`GET`| |Take an item out of a storage unit
[`/Api/CS2Interface/{botName}/StoreItem/{crateID}/{itemID}`](/CS2Interface/IPC/Documentation/Items/StoreItem.md)|`GET`| |Place an item into a storage unit

#### Players

API | Method | Parameters | Description
--- | --- | --- | ---
[`/Api/CS2Interface/{botName}/PlayerProfile/{steamID}`](CS2Interface/IPC/Documentation/Players/PlayerProfile.md)|`GET`| |Get a friend's player profile
[`/Api/CS2Interface/{botName}/PlayerProfile/{steamID}`](/CS2Interface/IPC/Documentation/Players/PlayerProfile.md)|`GET`| |Get a friend's player profile

#### Data

API | Method | Parameters | Description
--- | --- | --- | ---
[`/Api/CS2Interface/Recipes`](CS2Interface/IPC/Documentation/Data/Recipes.md)|`GET`|`showDefs`|Get a list of crafting recipes
[`/Api/CS2Interface/items_game.txt`](CS2Interface/IPC/Documentation/Data/ItemsGame.md)|`GET`| |Get the contents of items_game.txt
[`/Api/CS2Interface/Recipes`](/CS2Interface/IPC/Documentation/Data/Recipes.md)|`GET`|`showDefs`|Get a list of crafting recipes
[`/Api/CS2Interface/items_game.txt`](/CS2Interface/IPC/Documentation/Data/ItemsGameTxt.md)|`GET`| |Get the contents of items_game.txt

0 comments on commit 43620de

Please sign in to comment.