CS2Interface
CS2Interface copied to clipboard
Citrinate
An ASF Plugin for interacting with Counter-Strike 2
Counter-Strike 2 Interface Plugin for ArchiSteamFarm
Introduction
This plugin allows you to interact with Counter-Strike 2 using ArchiSteamFarm's IPC interface.
Installation
- Download the .zip file from the latest release
- Unpack the downloaded .zip file to the
pluginsfolder inside your ASF folder. - (Re)start ASF, you should get a message indicating that the plugin loaded successfully.
[!NOTE] This plugin is only tested to work with ASF-generic. It may or may not work with other ASF variants, but feel free to report any issues you may encounter.
Usage
Commands
| Command | Access | Description |
|---|---|---|
cs2interface |
FamilySharing |
Prints version of plugin. |
cstart [Bots] |
Master |
Starts the CS2 Interface |
cstop [Bots] |
Master |
Stops the CS2 Interface |
cstatus [Bots] |
Master |
Displays the status of the CS2 Interface |
Command Aliases
| Command | Alias |
|---|---|
cstatus asf |
csa |
AutoStartCS2Interface
bool type with default value of false. This configuration setting can be added to your individual bot config files. If set to true, the CS2 Interface will automatically start after the bot comes online. When used, FarmingPreferences should also have the FarmingPausedByDefault flag enabled.
"AutoStartCS2Interface": true,
"FarmingPreferences": 1,
[!NOTE] It's not possible for a bot to farm non-CS2 cards and use the CS2 Interface at the same time. These two operations can interfere with one another on startup, and so it's important to also enable the
FarmingPausedByDefaultflag. This will prevent ASF's CardFarmer module from starting automatically.If you want to farm cards you can still do so using the
resumecommand. The CS2 Interface will automatically start after card farming is complete.
IPC Interface
[!NOTE] Each bot can only process 1 request at a time.
[!NOTE] Once the plugin is installed additional documentation can be found, by default, at:
/swagger
| API | Method | Parameters | Description |
|---|---|---|---|
/Api/CS2Interface/{botNames}/Start |
GET |
Starts the CS2 Interface | |
/Api/CS2Interface/{botNames}/Stop |
GET |
Stops the CS2 Interface | |
/Api/CS2Interface/{botNames}/InspectItem |
GET |
url, s, a, d, m, minimal, showDefs |
Inspect a CS2 Item [^1] |
/Api/CS2Interface/{botName}/PlayerProfile/{steamID} |
GET |
Get a friend's CS2 player profile | |
/Api/CS2Interface/{botName}/Inventory |
GET |
minimal, showDefs |
Get the given bot's CS2 inventory |
/Api/CS2Interface/{botName}/GetCrateContents/{crateID} |
GET |
minimal, showDefs |
Get the contents of the given bot's crate |
/Api/CS2Interface/{botName}/StoreItem/{crateID}/{itemID} |
GET |
Stores an item into the specified crate | |
/Api/CS2Interface/{botName}/RetrieveItem/{crateID}/{itemID} |
GET |
Retrieves an item from the specified crate |
[^1]: Responses are not dependent on the account used to make these requests. You may provide multiple botNames, and the first available bot will be used to make the request.
Citrinate