Skip to content

Commands ja JP

ArchiBot edited this page Jun 10, 2025 · 84 revisions

コマンド

ASFはさまざまなコマンドをサポートしており、プロセスやボットインスタンスの動作を制御するために使用できます。

以下のコマンドは、さまざまな方法でボットに送信できます:

  • 対話式ASFコンソール
  • Steamプライベート/グループチャットを通じて
  • IPC インターフェースを通じて

ASFのアクセス許可に従ってコマンドの対象となるにはASFの対話が必要であることに注意してください。 詳細はSteamUserPermissionsSteamOwnerIDの設定プロパティを確認してください。

Steam チャットを通じて実行されるコマンドは、CommandPrefix **グローバル設定プロパティ**の影響を受けます。 これは、例えばstatusコマンドを実行する場合、実際には!status(または、代わりに設定したカスタムのCommandPrefix)と書く必要があることを意味する。 CommandPrefix はコンソールまたはIPCを使用する際には必須ではなく、省略することが可能です。


インタラクティブコンソール

ASFは、 ヘッドレス モードでASFを実行していない限り、対話型コンソールをサポートしています。 コマンドモードを有効にするには、 c ボタンを押すだけでコマンドを入力し、Enterを押して確認します。

スクリーンショット


Steamチャット

SteamチャットでもASFボットにコマンドを実行できます。 明らかに自分自身に直接話すことはできません。したがって、メインコマンドを実行したい場合は、少なくとも別のボットアカウントが必要です。

スクリーンショット

同様に、特定のSteamグループのグループチャットを使用することもできます。 このオプションは SteamMasterClanID プロパティを正しく設定する必要があることに留意してください。 その場合、ボットはグループチャットでもコマンドをリッスンします(必要に応じて参加します)。 プライベートチャットではなく、専用のボットアカウントを必要としないため、これは「自分自身と話す」ためにも使用できます。 You can simply set SteamMasterClanID property to your newly-created group, then give yourself access either through SteamOwnerID or SteamUserPermissions of your own bot. This way ASF bot (you) will join group and chat of your selected group, and listen to commands from your own account. You can join the same group chatroom in order to issue commands to yourself (as you'll be sending command to chatroom, and ASF instance sitting on the same chatroom will receive them, even if it shows only as your account being there).

Please note that sending a command to the group chat acts like a relay. If you're saying redeem X to 3 of your bots sitting together with you on the group chat, it'll result in the same as you'd say redeem X to every single one of them privately. In most cases this is not what you want, and instead you should use given bot command that is being sent to a single bot in private window. ASF supports group chat, as in many cases it can be useful source for communication with your only bot, but you should almost never execute any command on the group chat if there are 2 or more ASF bots sitting there, unless you fully understand ASF behaviour written here and you in fact want to relay the same command to every single bot that is listening to you.

And even in this case you should use private chat with [Bots] syntax instead.


プロセス間通信

The most advanced and flexible way of executing commands, perfect for user interaction (ASF-ui) as well as third-party tools or scripting (ASF API), requires ASF to be run in IPC mode, and a client executing command through IPC interface.

スクリーンショット


コマンド

コマンド アクセス Description
2fa [Bots] Master Generates temporary 2FA token for given bot instances.
2fafinalize [Bots] <ActivationCode> Master Finalizes process of assigning new 2FA credentials for given bot instances, using SMS/e-mail activation code.
2fafinalized [Bots] <ActivationCode> Master Imports already-finalized 2FA credentials for given bot instances, using 2FA token for verification.
2fafinalizedforce [Bots] Master Imports already-finalized 2FA credentials for given bot instances, skipping 2FA token verification.
2fainit [Bots] Master Starts process of assigning new 2FA credentials for given bot instances.
2fano [Bots] Master Denies all pending 2FA confirmations for given bot instances.
2faok [Bots] Master Accepts all pending 2FA confirmations for given bot instances.
addlicense [Bots] <Licenses> Operator Activates given licenses, explained below, on given bot instances (free games only).
balance [Bots] Master Shows wallet balance of given bot instances.
bgr [Bots] Master Prints information about BGR queue of given bot instances.
bgrclear [Bots] Master Clears BGR queue of given bot instances.
encrypt <encryptionMethod> <stringToEncrypt> Owner Encrypts the string using provided cryptographic method - further explained below.
exit Owner Stops whole ASF process.
farm [Bots] Master Restarts cards farming module for given bot instances.
fb [Bots] Master Lists apps blacklisted from automatic farming of given bot instances.
fbadd [Bots] <AppIDs> Master Adds given appIDs to apps blacklisted from automatic farming of given bot instances.
fbrm [Bots] <AppIDs> Master Removes given appIDs from apps blacklisted from automatic farming of given bot instances.
fq [Bots] Master Lists priority farming queue of given bot instances.
fqadd [Bots] <AppIDs> Master Adds given appIDs to priority farming queue of given bot instances.
fqrm [Bots] <AppIDs> Master Removes given appIDs from farming queue of given bot instances.
hash <hashingMethod> <stringToHash> Owner Generated a hash of the string using provided cryptographic method - further explained below.
help FamilySharing Shows help (link to this page).
input [Bots] <Type> <Value> Master Sets given input type to given value for given bot instances, works only in Headless mode - further explained below.
inventory [Bots] Operator Shows inventory summary of given bot instances.
level [Bots] Master Shows Steam account level of given bot instances.
loot [Bots] Master Sends all LootableTypes Steam community items of given bot instances to Master user defined in their SteamUserPermissions (with lowest steamID if more than one).
loot@ [Bots] <AppIDs> Master Sends all LootableTypes Steam community items matching given AppIDs of given bot instances to Master user defined in their SteamUserPermissions (with lowest steamID if more than one). This is the opposite of loot%.
loot% [Bots] <AppIDs> Master Sends all LootableTypes Steam community items apart from given AppIDs of given bot instances to Master user defined in their SteamUserPermissions (with lowest steamID if more than one). This is the opposite of loot@.
loot^ [Bots] <AppID> <ContextID> Master Sends all Steam items from given AppID in ContextID of given bot instances to Master user defined in their SteamUserPermissions (with lowest steamID if more than one).
loot& [Bots] <AppID> <ContextID> <Rarities> Master Sends all Steam items from given AppID in ContextID matching given Rarities of given bot instances to Master user defined in their SteamUserPermissions (with lowest steamID if more than one).
mab [Bots] Master Lists apps blacklisted from automatic trading in MatchActively.
mabadd [Bots] <AppIDs> Master Adds given appIDs to apps blacklisted from automatic trading in MatchActively.
mabrm [Bots] <AppIDs> Master Removes given appIDs from apps blacklisted from automatic trading in MatchActively.
match [Bots] Master Special command for ItemsMatcherPlugin which triggers MatchActively routine immediately.
nickname [Bots] <Nickname> Master Changes Steam nickname of given bot instances to given nickname.
owns [Bots] <Games> Operator Checks if given bot instances already own given games, explained below.
[Bots] を一時停止 Operator Permanently pauses automatic cards farming module of given bot instances. ASF will not attempt to farm current account in this session, unless you manually resume it, or restart the process.
pause~ [Bots] FamilySharing Temporarily pauses automatic cards farming module of given bot instances. Farming will be automatically resumed on the next playing event, or bot disconnect. You can resume farming to unpause it.
pause& [Bots] <Seconds> Operator Temporarily pauses automatic cards farming module of given bot instances for given amount of seconds. After delay, cards farming module is automatically resumed.
play [Bots] <AppIDs,GameName> Master Switches to manual farming - launches given AppIDs on given bot instances, optionally also with custom GameName. In order for this feature to work properly, your Steam account must own a valid license to all the AppIDs that you specify here, this includes F2P games as well. Use reset or resume for returning.
points [Bots] Master Displays number of points in Steam points shop.
privacy [Bots] <Settings> Master Changes Steam privacy settings of given bot instances, to appropriately selected options explained below.
redeem [Bots] <Keys> Operator Redeems given cd-keys or wallet codes on given bot instances.
redeem^ [Bots] <Modes> <Keys> Operator Redeems given cd-keys or wallet codes on given bot instances, using given modes explained below.
redeempoints [Bots] <DefinitionIDs> Operator Redeems Steam points for given assets on given bot instances. By default, only free items are allowed, append ! character at the end of each DefinitionID that you want to redeem unconditionally, even if paid.
reset [Bots] Master Resets the playing status back to original (previous) state, the command is used during manual farming with play command.
再起動 Owner Restarts ASF process.
[Bots] を再開 FamilySharing Resumes automatic farming of given bot instances.
rmlicense [Bots] <Licenses> Master Removes given licenses, explained below, on given bot instances.
[Bots] をスタート Master Starts given bot instances.
stats Owner Prints process statistics, such as managed memory usage.
status [Bots] FamilySharing Prints status of given bot instances.
std [Bots] Master Special command for SteamTokenDumperPlugin which triggers refresh of selected bots and submission of data immediately.
[Bots] を停止 Master Stops given bot instances.
tb [Bots] Master Lists blacklisted users from trading module of given bot instances.
tbadd [Bots] <SteamIDs64> Master Blacklists given steamIDs from trading module of given bot instances.
tbrm [Bots] <SteamIDs64> Master Removes blacklist of given steamIDs from trading module of given bot instances.
transfer [Bots] <TargetBot> Master Sends all TransferableTypes Steam community items from given bot instances to target bot instance.
transfer@ [Bots] <AppIDs> <TargetBot> Master Sends all TransferableTypes Steam community items matching given AppIDs from given bot instances to target bot instance. This is the opposite of transfer%.
transfer% [Bots] <AppIDs> <TargetBot> Master Sends all TransferableTypes Steam community items apart from given AppIDs from given bot instances to target bot instance. This is the opposite of transfer@.
transfer^ [Bots] <AppID> <ContextID> <TargetBot> Master Sends all Steam items from given AppID in ContextID of given bot instances to target bot instance.
transfer& [Bots] <AppID> <ContextID> <TargetBot> <Rarities> Master Sends all Steam items from given AppID in ContextID matching given Rarities of given bot instances to target bot instance.
unpack [Bots] Master Unpacks all booster packs stored in the inventory of given bot instances.
update [Channel] Owner Checks GitHub for new ASF release and updates to it if available. This is normally done automatically every UpdatePeriod. Optional Channel argument specifies the UpdateChannel, if not provided defaults to the one set in global config. Channel can end with ! character, which will force update available on given channel - including a possibility of e.g. downgrading.
updateplugins [Channel] [Plugins] Owner Updates selected plugins. Optional Channel property allows you to pick a different UpdateChannel for plugin updates, if they support multiple ones. Channel can end with ! character, which will force update available on given channel - including a possibility of e.g. downgrading, although exact functionality depends on a particular plugin. When Plugins are not provided, then all plugins considered for automatic updates through PluginsUpdateList and PluginsUpdateMode are updated. If you want to update selected ones, especially those disabled from automatic updates by default, you need to provide Channel as well as Plugins you want to update, then ASF will proceed with updating them regardless of their automatic updates setting.
バージョン FamilySharing Prints version of ASF.

備考

All commands are case-insensitive, but their arguments (such as bot names) are usually case-sensitive.

Arguments follow UNIX philosophy, square brackets [Optional] indicate that given argument is optional, while angle brackets <Mandatory> indicate that given argument is mandatory. You should replace the arguments that you want to declare, such as [Bots] or <Nickname> with actual values that you want to issue the command with, omitting the braces.

[Bots] argument, as indicated by the brackets, is optional in all commands. When specified, command is executed on given bots. When omitted, command is executed on current bot that receives the command (Steam chat), or in according to DefaultBot configured property (IPC and interactive console).

As an example, status A sent to bot B is the same as sending status to bot A, bot B in this case acts only as a proxy. This can also be used for sending commands to bots that are unavailable otherwise, for example starting stopped bots, or executing actions on your main account (that you're using for executing the commands).

Access of the command defines minimum EPermission of SteamUserPermissions that is required to use the command, with an exception of Owner which is SteamOwnerID defined in global configuration file (and highest permission available).

Plural arguments, such as [Bots], <Keys> or <AppIDs> mean that command supports multiple arguments of given type, separated by a comma. For example, status [Bots] can be used as status MyBot,MyOtherBot,Primary. This will cause given command to be executed on all target bots in the same way as you'd send status to each bot in a separate chat window. Please note that there is no space after ,.

ASF uses all whitespace characters as possible delimiters for a command, such as space and newline characters. This means that you don't have to use space for delimiting your arguments, you can as well use any other whitespace character (such as tab or new line).

ASF will "join" extra out-of-range arguments to plural type of the last in-range argument. This means that redeem bot key1 key2 key3 for redeem [Bots] <Keys> will work exactly the same as redeem bot key1,key2,key3. Together with accepting newline as command delimiter, this makes it possible for you to write redeem bot then paste a list of keys separated by any acceptable delimiter character (such as newline), or standard , ASF delimiter. Keep in mind that this trick can be used only for command variant that uses the most amount of arguments (so specifying [Bots] is mandatory in this case).

As you've read above, a space character is being used as a delimiter for a command, therefore it can't be used in arguments. However, also as stated above, ASF can join out-of-range arguments, which means that you're actually able to use a space character in argument that is defined as a last one for given command. For example, nickname bob Great Bob will properly set nickname of bob bot to "Great Bob". In the similar way you can check names containing spaces in owns command.


Some commands are also available with their aliases, mostly to save you on typing or account for different dialects:

コマンド 別名
addlicense al, addlicence
addlicense ASF ala
owns ASF oa
status ASF sa
redeem r
redeem^ r^
redeempoints rp
rmlicense rl, rmlicence

[Bots] 引数

[Bots] argument is a special variant of plural argument, as in addition to accepting multiple values it also offers extra functionality.

First and foremost, [Bots] argument supports predefined "bot groups", which are defined as below:

名前 Description
@all, ASF All bots defined in the instance
@ファーム Bots that are currently farming
@idle Bots that are currently not farming
@オフライン Bots that are currently not connected to the Steam network
@オンライン Bots that are currently connected to the Steam network

For example, status ASF command is equal to status all,your,bots,listed,here. This can also be used to easily identify the bots that you have access to, as ASF keyword, despite of targeting all bots, will result in response only from those bots that you can actually send the command to. Other groups are also available in order to more easily execute given command only on specific bots meeting the condition.

[Bots] argument also supports special "range" syntax, which allows you to choose a range of bots more easily. The general syntax for [Bots] in this case is [FirstBot]..[LastBot]. At least one of the arguments must be defined. When using <FirstBot>.., all bots starting from FirstBot are affected. When using ..<LastBot>, all bots until LastBot are affected. When using <FirstBot>..<LastBot>, all bots within range from FirstBot until LastBot are affected. For example, if you have bots named A, B, C, D, E, F, you can execute status B..E, which is equal to status B,C,D,E in this case. When using this syntax, ASF will use alphabetical sorting in order to determine which bots are in your specified range. Arguments must be valid bot names recognized by ASF, otherwise range syntax is entirely skipped.

In addition to range syntax above, [Bots] argument also supports regex matching. You can activate regex pattern by using r!<Pattern> as a bot name, where r! is ASF activator for regex matching, and <Pattern> is your regex pattern. An example of a regex-based bot command would be status r!^\d{3} which will send status command to bots that have a name made out of 3 digits (e.g. 123 and 981). Feel free to take a look at the docs for further explanation and more examples of available regex patterns.


privacy 設定

<Settings> 引数は 最大 7 つの 異なるオプションを受け付けます。通常のコンマASFの区切り文字で区切られます。 順番は以下の通りです:

引数 名前 Child of
1 プロファイル
2 OwnedGames プロファイル
3 Playtime OwnedGames
4 FriendsList プロファイル
5 インベントリ プロファイル
6 InventoryGifts インベントリ
7 コメント プロファイル

上記のフィールドの説明については、 Steamプライバシー設定 をご覧ください。

すべての有効な値は次のとおりです:

名前
1 Private
2 FriendsOnly
3 Public

大文字小文字を区別しない名前、または数値を使用できます。 省略された引数はデフォルトで Private に設定されます。 子が親よりもオープンな権限を持つことはできないため、上記で指定された引数の子と親の関係に注意することが重要です。 For example, you can't have Public games owned setting while having Private profile setting.

メイン という名前のボットの すべての プライバシー設定を プライベートに設定したい場合 以下のいずれかを使用できます:

privacy Main 1
privacy Main Private

これは、ASFが自動的に他のすべての設定を プライベートと仮定するため、入力する必要はありません。 一方、すべてのプライバシー設定を Publicに設定したい場合は、以下のいずれかを使用する必要があります:

privacy Main 3,3,3,3,3,3,3
privacy Main Public,Public,Public,Public,Public,Public,Public

この方法では、以下のように独立したオプションを設定することもできます:

privacy Main Public,FriendsOnly,Private,Public,Public,Private,Public

上記のプロフィールは公開され、友達のみに所有されているゲームはプライベートにプレイ時間を設定します。 公開、インベントリから公開、個人へのギフト、プロフィールへのコメントなどに友達が一覧表示されます。 必要に応じて数値でも同じことができます。


Licenses

addlicense and rmlicense commands support two different license types, those are:

Type 別名 備考
app a app/292030 ユニークな appID によって決定されるゲーム。
sub s sub/47807 1 つ以上のゲームを含むパッケージ, 固有の サブID によって決定します。

The distinction is important, as ASF will use Steam network method for apps, and Steam store method for packages. Those two are not compatible with each other.

When activating new licenses, typically you'll want to specify app for free weekends/permanently F2P games, and package otherwise.

For removal of existing license, both methods will work, although we recommend to remove packages in order to have deterministic and explicit request, as otherwise Steam might remove packages you didn't intend to be removed, especially if your account has more than one package granting access to given app.

We recommend to explicitly define the type of each entry in order to avoid ambiguous results, but for the backwards compatibility, if you omit type entirely, ASF will assume that you ask for sub in this case. また、標準の ASF , デリミタを使用して、1つまたは複数のライセンスを同時に照会することもできます。

Complete command examples:

addlicense ASF app/292030
addlicense ASF sub/303386
rmlicense ASF app/292030,sub/303386

owns ゲーム

owns command supports several different game types for <games> argument that can be used, those are:

タイプ 別名 備考
app a app/292030 Game determined by its unique appID.
sub s sub/47807 1 つ以上のゲームを含むパッケージ, 固有の サブID によって決定します。
regex r regex/^\d{4}: Regex は、ゲームの名前に適用され、大文字と小文字を区別します。 完全な構文と他の例については、 ドキュメント を参照してください。
名前 n name/Witcher ゲームの名前の一部、大文字小文字を区別しません。

曖昧な結果を避けるために、各エントリの型を明示的に定義することをお勧めします。 しかし後方互換性のために無効な型を与えたり 完全に省略すれば ASFは、入力が数値である場合は アプリ を、そうでない場合は 名前 を要求すると仮定します。 また、標準 ASF , デリミタを使用して、ゲームの 1 つまたは複数のクエリを同時に実行することもできます。

完全なコマンド例:

owns ASF app/292030,name/Witcher

redeem^ modes

redeem^ コマンドを使用すると、単一のやり直しのシナリオで使用されるモードを微調整できます。 これは、 RedeemingPreferences ボット設定プロパティ の一時的なオーバーライドとして機能します。

<Modes> 引数は、通常通りコンマで区切られた複数のモード値を受け取ります。 使用可能なモード値は以下のとおりです:

名前 備考
FAWK ForceAssumeWalletKey Forces AssumeWalletKeyOnBadActivationCode redeeming preference to be enabled
FD ForceDistributing Forces Distributing redeeming preference to be enabled
FF ForceForwarding Forces Forwarding redeeming preference to be enabled
FKMG ForceKeepMissingGames Forces KeepMissingGames redeeming preference to be enabled
SAWK SkipAssumeWalletKey Forces AssumeWalletKeyOnBadActivationCode redeeming preference to be disabled
SD SkipDistributing Forces Distributing redeeming preference to be disabled
SF SkipForwarding Forces Forwarding redeeming preference to be disabled
SI SkipInitial Skips key redemption on initial bot
SKMG SkipKeepMissingGames Forces KeepMissingGames redeeming preference to be disabled
V Validate Validates keys for proper format and automatically skips invalid ones

例えば、ゲームをまだ所有していないボットでも、 プライマリ ボットではなく、3つのキーを引き換えたいと考えています。 それを達成するために私たちは使用することができます:

redeem^ primary FF,SI key1,key2,key3

It's important to note that advanced redeem overrides only those RedeemingPreferences that you specify in the command. For example, if you've enabled Distributing in your RedeemingPreferences then there will be no difference whether you use FD mode or not, because distributing will be already active regardless, due to RedeemingPreferences that you use. 強制的に有効化されたオーバーライドにも強制的に無効化されたものがあるのはこのためです。 無効にするか無効にするか自分で決めればいい。


encrypt command

encrypt コマンドを使用すると、ASFの暗号化方法を使用して任意の文字列を暗号化できます。 <encryptionMethod> は、 セキュリティ セクションで指定され説明されている暗号化方法のいずれかでなければなりません。 このコマンドは、セキュアなチャネル(ASFコンソールまたはIPCインターフェース、または専用のAPIエンドポイントを持つ)を通じて使用することをお勧めします。 機密情報が様々な第三者によって記録される可能性があるため(例えばSteamサーバーによって記録されるチャットメッセージなど)。


ハッシュ コマンド

hash コマンドを使用すると、ASFのハッシュメソッドを使用して任意の文字列のハッシュを生成できます。 <hashingMethod> は、 セキュリティ セクションで指定され説明されているハッシュメソッドのいずれかでなければなりません。 このコマンドは、セキュアなチャネル(ASFコンソールまたはIPCインターフェース、または専用のAPIエンドポイントを持つ)を通じて使用することをお勧めします。 機密情報が様々な第三者によって記録される可能性があるため(例えばSteamサーバーによって記録されるチャットメッセージなど)。


input コマンド

input コマンドは、ユーザーインタラクションのサポートなしでASFが実行されている場合に、IPC またはSteamチャットを介して与えられたデータを入力するために、Headless モードでのみ使用できます。

一般的な構文は 入力 [Bots] <Type> <Value> です。

<Type> は大文字小文字を区別せず、ASFによって認識される入力タイプを定義します。 現在ASFは以下のタイプを認識しています:

タイプ 備考
ログイン SteamLogin ボットの config プロパティが設定されていない場合。
パスワード SteamPassword bot config property, if missing from config.
SteamGuard 2FAを使用していない場合は、認証コードをメールに送信しました。
SteamParentalCode SteamLogin ボットの config プロパティが設定されていない場合。
TwoFactorAuthentication モバイルから生成された2FAトークンです。2FAを使用していてもASF2FAではありません。

<Value> は、指定された型に設定された値です。 現在、すべての値は文字列です。

2FAモード以外でSteamGuardによって保護されているボットがあるとしましょう。 ヘッドレスtrue に設定されているボットを起動します。

In order to do that, we need to execute following commands:

start MySteamGuardBot -> Bot will attempt to log in, fail due to AuthCode needed, then stop due to running in Headless mode. Steam ネットワークに認証コードをメールで送信させるために必要です。必要がない場合。 私たちはこのステップを完全に飛ばします。

input MySteamGuardBot SteamGuard ABCDE -> We set SteamGuard input of MySteamGuardBot bot to ABCDE. もちろん、この場合 ABCDE は認証コードであり、メールで取得しました。

start MySteamGuardBot -> We start our (stopped) bot again. 今回は自動的に以前のコマンドで設定した認証コードを使用し、適切にログインし、消去します。

同じ方法で、2FA保護されたボットにアクセスすることができます(ASF 2FAを使用していない場合)、実行時に他の必要なプロパティを設定することもできます。


認識されたレアリティ

ASF recognizes following rarities:

レアリティ 別名
Unknown
Common
Uncommon
Rare
Mythical Epic
Legendary Exotic
Ancient Extraordinary
Immortal Contraband
Arcana
Unusual

ASF希少性によって認識されない(上記の定義を除く)ことは、 Unknown として定義されます。

Clone this wiki locally