Steamworks ドキュメンテーション
Steamワークショップ
概略
Steamワークショップは、製品のファンやコミュニティメンバーが、ゲームのコンテンツの作成に参加できる場所です。
統合のレベル
かなり高度ですが、使い方によって変わってきます。 ゲーム内でアップロードパスを作成するか、別途ツールが必要です。 さらに、ゲームにコンテンツを手動で統合するか、またはディスクからダウンロードしたMODをゲームに読み込みます。

概要

Steamワークショップは、製品のファンやコミュニティメンバーが、ゲームのコンテンツ作成に参加できる場所として設計されました。 The form of this creation by community members can vary depending on the nature of the game and what kind of control you wish to have over the content in your game.

This page is intended as an overview of the Steam Workshop and the different models available. For technical details on implementing Steam Workshop with your title, please see the Steamワークショップ実装ガイド.

動画:UGC(ユーザー生成コンテンツ)とSteamワークショップ入門

https://www.youtube.com/watch?v=SRyUpR4qOxU

動画:ARK: Survival EvolvedにおけるUGCとワークショップ

Here's a talk given by Jeremy Stieglitz of Studio Wildcard at Steam Dev Days 2016 on how leveraging User Generated Content via the Steam Workshop has helped foster a long and pro-active community for their title ARK: Surivival Evolved. And some of the technical and design steps they took to make it happen.
https://www.youtube.com/watch?v=faweKXUTKgQ

ワークショップブランドガイドライン

You are welcome to use Steam Workshop branding when promoting your Workshop. Click here to download Workshop branding assets. For more information about general Steam branding, refer to the Steamブランドガイドライン.

ワークショップのタイプ

There are two main types of Steam Workshop integration options available. Each has benefits and trade-offs, so you should think carefully about which option makes the most sense for your product.
  1. すぐに使えるワークショップ―誰でもコンテンツをアップロードでき、プレイヤーは一切のキュレーションなしでダウンロードができます。 ゲームの複雑性によらず、ゲーム内で大量のアイテムや、Mod、マップをサポートする場合に最適です。 適切なエディター、ゲーム内でコンテンツが適切に機能することを確認するための検証ツールを作成するための事前作業に時間がかかることがあります。 アイテム制作者はコンテンツをいつでも更新できます。

  2. キュレーションされたワークショップ―ゲームに追加するアイテムを厳重に管理したい場合に最適ですが、アイテムをひとつ追加する毎に作業とアップデートが必要になります。 この方法は通常、武器や、帽子、装飾アイテムのような、小さくあまり複雑でないコンテンツ用です。 アイテムを販売する場合には、ゲーム内でどのユーザーがアイテムを装備しているかを追跡するための永続的なアイテムストレージサービス(Steamインベントリサービスなど)の利用が必要となるほか、アイテム販売用にゲームストアを用意する必要があります。 価格設定は開発側が行います。

すぐに使えるワークショップ

使用理由

  • 大量のアイテムに対応したい。「すぐに使えるワークショップ」を使用すると、複雑性によらずゲーム内で大量のアイテムや、Mod、マップに対応することが容易になります。 コンテンツ制作ツールや編集ツールを事前に用意することで、ユーザーがゲーム内でできることが増えます。
  • 制作者がコンテンツをいつでも自由に更新できるようにしたい。「すぐに使えるワークショップ」のアイテムは制作者がいつでも自由に更新できます。つまり、コンテンツの編集、バグの修正、あるいはMODやアイテムの内容や機能の拡張などは制作者が自由に行えます。

はじめに

The best way to get started is to think about what kind of content is best suited for your customers to create to expand your game. For multi-player games you may have different kinds of content that makes sense than if you have a single-player game. Once you've figured that out, then you'll need to think about how your client will load the content and what kind of tools are necessary for customers to create that content. If you've got a game that customers are excited about, then they'll figure out ways of making the content for your game. But, as mentioned earlier, if you wish to support large scale modding of your game, you'll find it useful to release as much of your own development tools as possible to aid in the creation of content and modification of your game logic.

Once you've got basic modding up and running, then you'll need to integrate the ISteamUGC API so that your client can know which Workshop files the user is subscribed to and can download content as necessary. From there, enabling the option to sell items in this environment is trivial. The Steam Workshop takes care of collecting bank and tax info from authors, provides the tools for specifying pricing, provides the necessary user agreements, and handles all the backend payment processing and tax witholding. Your game just needs to figure out which files to load into your game client.

統合作業

Here are some of the typical components to think about for integration of the Ready-To-Use Workshop model with your game:
  • シングルプレイヤーのゲームクライアントにコンテンツを読み込む―ユーザーが提出したコンテンツをゲーム内ですぐ使用できるようにするには、ゲームの適切な構築が必要です。 これは通常、ゲームクライアントが読み込むべきファイルを確認する必要があることを意味します。 新たに実装を構築する場合は、Steamユーザーがサブスクライブしたファイルのリストを最初にチェックしてから、対応するフォルダの読み込みを行うことを推奨しています。 開発側はMOD制作者がMODをディレクトリから読み込んで作業できるようにステージング環境を用意する必要があります。
  • マルチプレイヤーゲームクライアントにコンテンツを読み込む―ゲームを適切に機能せさせるために、複数のユーザーが必要とするアイテムやコンテンツがある場合、特定のアイテムを必要とするすべてのクライアントに対し、このアイテムをすべてダウンロードさせることができます。 例えば、ワークショップのカスタムマップをサブスクライブしているユーザーが、マッチにフレンドを招待した場合、招待されたユーザーのマッチへの接続が完了する前に、カスタムマップが使用されていることがゲームによって認識され、コンテンツがワークショップから招待されたユーザー側でダウンロードされる必要があります。
  • アイテム制作者からのエントリーをアップロードするISteamUGC APIを使用して、アイテム制作者がワークショップにエントリーをアップロードできるようなツールを用意する必要があります。 このツールには、ゲーム内フォームのような単純なものから、スタンドアロンのアプリまであります。受け付けるアイテムは即時使用可能とになる必要があるため、提出ツールは、ゲームクライアントによる読み込みが想定されたファイルフォーマットとそのプレビューイメージのみを受け付けるべきです。 制作者に対してアップロードを依頼するコンテンツにもよりますが、大規模な改変(ゲームロジックやゲームプレイに関するもの、または既存のビジュアルの変更以上のもの)がある場合は特に、専用の編集ツールの提供が必要かもしれません。 例えば、Mod制作が可能なゲームのほとんどは、開発に使用したツールを公開し、Mod制作者が開発と同じツールを使用できるようにしています。 ファイルの上書きや、ゲーム内の変更可能部分を管理したい場合、こうしたツールによって、提出されたコンテンツの制限や認証が可能になります。 ワークショップアイテムの制作希望者に向けて、求めているコンテンツの種類、および投稿してもらいたくないコンテンツの種類に関するガイドラインやスタイルガイドを作成することが推奨されます。

    Steamworks APIのSteamワークショップ部分の使用を開始するための詳細はSteamワークショップ実装ガイドをご覧ください。

ユーザーにアイテムを渡す

With the Ready-To-Use Workshop model, items listed in the Workshop are automatically available to subscribe to (if free) or to purchase (if paid) and then are automatically downloaded via the Steam client (Integration of the ISteamUGC API with your product is necessary for this to work correctly. See the technical documentation on the Steamワークショップ実装ガイド). The Steam Workshop handles keeping the client up to date with any mod updates. If the mod was purchased, then Steam handles purchase of the item, payment processing, payments to the authors, payments to the game developer, and any necessary tax withholding.

If you wish, you can build an in-game Workshop browser to list the same set of items.

キュレーションされたワークショップ

The defining characteristic of a curated Steam Workshop is that as the developer, you will need to approve each item and you'll probably need an item server (Or to use the Steam Inventory Service) for managing ownership of the items. This process affords a lot of control over the items that get added to your game, but typically involves at least a small amount of work to accept each new item.

Within a Curated Workshop, the items posted in the Workshop are not available for direct use by other customers via the Workshop, but are instead presented in a queue for customers to vote on. This voting gives you data on which items are desired by the most users and helps you filter out incomplete or inappropriate submissions.

使用理由

The Curated Workshop model is useful for your game if you:
  • アイテムに特定の属性を割り当てる必要がある。ワークショップ経由で武器などのアイテムを受け付ける場合、ゲームプレイのバランスを損なわないように、 開発者による武器の属性(スピード、パワー、ダメージ、リロード時間等)の割り当てが必要です。
  • ゲームに追加されるコンテンツを厳重に管理したい。 ゲームのセットアップよって、アイテムの受け入れには2種類の方法があります。
    • ダウンロードして構築―アセットをローカルマシンにダウンロードしてゲームデポに含みたい場合。 各アイテムの最適化や、厳格なスタイルガイドを課す必要がある場合、アイテムの編集や修正を行うことができます。
    • クライアントに直接―受け入れたアイテムを必要に応じてクライアントに直接ダウンロードしたい場合。 バグがあった場合、アイテム制作者が自ら制作物を更新できます。

はじめに

You can get started right away by setting up your curated Workshop page, adding a simple form within your game, and posting guidelines and style guide information for potential item creators. To upload content to the Workshop, you'll need to integrate the ISteamUGC API (See the Steamワークショップ実装ガイド). This will let item authors start coming up with ideas and posting their items to your Workshop for evaluation by the community. We typically suggest that you ask item authors to post finished items to the Workshop. If you allow users to post incomplete work or mere concepts, then you will need to figure out what the process would be that those concepts get turned into real items, which typically becomes a difficult to scale up in any meaningful way.

Once you have your Workshop up and running, you can be working on integrating with the Steam Microtransactions API and the Steam Inventory Service in anticipation of selling the accepted items. When you have your store ready to go, you can then start accepting items, setting payment rules, and selling those items.

統合作業

Here are some of the typical components to think about for integration of the Curated Workshop model with your game:
  • アイテム制作者からのエントリーを受け入れる―アイテム制作者がワークショップにエントリーをアップロードするためのツールが必要です。 このツールには、ゲーム内のフォームのような単純なものから、スタンドアロンのアプリまであります。アイテム制作者に.ZIPファイルとプレビュー画像を選択させるだけの初歩的なアップローダーで始めることも可能ですし、提出過程にさらなる検証ステップを組み込むことも可能です。 例えば、Team Fortress 2は、アイテム制作者が.ZIPファイルとプレビュー画像を選ぶだけの提出フォームで開始しましたが、 イテレーションのプロセスの中で、ワークショップに提出されたファイルのゲームとの統合を簡素化するための検証ステップやテスト環境を追加しました。

    ワークショップアイテムの制作希望者に向けて、求めているコンテンツの種類や、投稿してもらいたくないコンテンツに関するガイドラインやスタイルガイドを作成することを推奨します。

    ユーザーが提出ツールからワークショップにアイテムをアップロードしたら、投稿されたアイテムのページをそのユーザーに向けて表示するようにしましょう。 そうすることで、Steam利用規約やSteamワークショップ利用規約などにまだ同意していないユーザーは、規約に同意する機会を得ます。
  • アイテムをゲームに統合する(任意)―アイテム制作者がアップロードの際に定義できない特別な属性(武器の効果など)を開発者側で割り当てる必要がある場合、ワークショップのWebサイトからアイテムをダウンロードし、デポにコンテンツを含む必要があります。 その過程で、適切な属性の割り当てと必要な編集を行ってください。 このステップにおける作業量は、提出ツールの検証作業の量と、アイテム制作者から受け取るコンテンツの質によって変動します。
  • その場でダウンロードする ―特別な属性の設定や、アイテムを洗練するための処理が必要がない場合、所有アイテムをワークショップコンテンツサーバーから直接呼び出すことができます。 Steamインベントリサービスを使用している場合、ISteamInventoryを使用して、ユーザーが所有するアイテムのリストを見ることができます。 そこで、ユーザーが所有する各アイテムがワークショップアイテムかどうかをチェックして、以下を行います。
    • ワークショップアイテムIDでISteamUGC::GetItemStateを呼び出し、k_EItemStateNeedsUpdateが設定されているか、あるいは k_EItemStateInstalledが設定されていないかをチェックします。
    • 必要であればISteamUGC::DownloadItemを呼び出します。
    • ISteamUGC::DownloadItemResult_tのコールバックを待ち、コンテンツをゲーム内で利用可能にします。
  • インベントリサービス、アイテム定義の作成―アイテムをゲーム内で販売する場合や、一部のユーザーに限定で配布する場合、各アイテムの所有権を追跡し、どのクライアントがそのアイテムを装備する許可を所有しているかをゲーム側で把握するために、アイテムサーバーが必要になります(またはSteamインベントリサービスも使用可能です)。 このインベントリサービスは、アイテムの販売だけでなく、ランダムドロップや、ユーザーにアイテムをドロップするイベントの管理にも必要です。
  • 支払いルールの追加―アイテムの販売準備が整ったら、Steamインベントリサービスや、アイテムサーバー内で、どのワークショップアイテムがどのアイテム定義に関連付けられているかをSteamに知らせる必要があります。 この関連付けによって支払いルールが確立され、Steamは各アイテムの販売収益の適切な分配率を把握することができます。 インベントリサービスでSteam Microtransactions APIを通して売上が発生すると、Steamはどのワークショップアイテムが購入されたかを把握し、正しい収益の計算とアイテム制作者への支払いを引き受けます。

    アプリのSteamworks設定ページのワークショップタブの下にある「新規の支払ルールを入力」をクリックすることによって支払いルールを管理できます。

  • アイテムの販売 ―アイテムを販売するストアを用意したい場合、自身でゲーム内へのストア用のUIを作成するか、Steamアイテムストアの使用が可能です。 各購入におけるバックエンドの処理はSteamが引き受けます(以下参照)。
    • 各アイテム制作者の銀行および税務情報の収集と保管
    • アイテム販売に対する適切な計算処理と製作者への支払い
    • 各アイテム制作者の源泉徴収
    • 各アイテム制作者への年度末税務書類の発行

ユーザーにアイテムを渡す

With the Curated Workshop model, there are a number of ways you can allow customers to get the items:
  • Steam Microtransactions経由で販売―独自のインベントリサービスを使用している場合、Steam Microtransactions APIとの統合が必要です。 または、アイテムの出品および販売用にカスタマイズできるアイテムストアを備えたSteam インベントリサービスの利用も可能です。
  • ランダムアイテムドロップ―各アイテムの所有権追跡やドロップの管理を行うためのアイテムサーバーが必要です(Steam インベントリサービスの利用も可能です)。
  • DLCとしてバンドル―インフラの準備は少なくて済みますが、ワークショップへの貢献者に対する支払い条件を各自で準備する必要があります。 DLCやDLCの一部として販売される各アイテムに関して、支払い金額や、支払い頻度(容易な一回払い)、または著作権使用料としての継続的な支払い(継続的な作業が必要)について、ワークショップ作成者と合意を形成する必要があります。 さらに、支払いの記録、源泉徴収の計算、事業を行っている地域によっては、適切な税務書類の発行が必要となります。
  • 誰でも無料で使用できるアイテムとしてゲームに追加―必要なインフラは最小限で済みますが、アイテム制作者のモチベーションが上がらず、高品質な作品の提出を望めなくなります。

告知とローンチ

必要なマーケティング素材

To prepare your Workshop for launch, you'll need to supply the following items:
  • ワークショップのヘッダー画像―この画像はホームページ上で製品を際立たせるためのものです。 Photoshopのテンプレートはこちらです。 アートワークやロゴはゲームを象徴するものを使用してください。 右側にSteamワークショップの使用方法に関する説明とそのタイトルを書くためのスペースを用意してください。
  • 簡単な説明―タイトルを付け、アプリケーションがSteamワークショップをどのように使用するかを2行以内で説明してください。 これによって、ツール内の機能や使用方法に関するユーザーの期待値が設定されます。
  • ツールのドキュメント―ユーザーがツールを使用する上で役立つドキュメントをWebサイトやWikiで公開している場合、そのURLをアプリのワークショップ設定ページに入力してください。または、ワークショップ用コンテンツ作成に使用するツールを新規ユーザーに紹介するためのSteamガイドの制作を検討してください。

ローンチの告知とタイミング

When you launch your Workshop integration, it may be a great opportunity to run a discount on your product to capitalize on the additional buzz of the new Workshop and to get a bunch of new players to use the Workshop. You can configure your own discount to run in conjunction with your Workshop launch. For more details, please see the 割引 documentation.

Additionally, you can use an Update Visibility Round to get front-page visibility for your game to promote your new Workshop and sale (if you are running one). For more information on Visibility Rounds, please see Steamでの露出 documentation.

With a broad announcement of Workshop as a marketing tool, we find it helpful for potential customers if there is some amount of content already available in the Workshop for your game. It gives new customers a deeper sense of what your game is, and also shows an active and engaged user base. It also gives existing customers something actionable to do right away, and shows content creators what kinds of things they can create for your Workshop. At the very least, one item will need to be published in your Workshop for your game to appear at all in the list on the front page of the Steam Workshop.

There are a couple ways to accomplish this:
  1. ローンチ前に機密でコンテンツを生成してテストを少人数のグループで行いたい場合、非公開のベータとして数名のユーザーだけを招待することが可能です。 ベータの実施に関する詳細情報は、以下のトピックを参照してください。
  2. ツールのデモンストレーションとして、いくつかのアイテムを内部で制作することも可能です。

プライベートベータの実施

Steam and the Steam Workshop makes it easy to run a private beta to allow a group of early testers to use your new tools and test the integration with the Workshop. This is a great way to get feedback on the flow of generating content and publishing and also to potentially launching your Workshop with a collection of items ready for fans to check out.

There are two parts to this:
  1. ゲームのベータ(Steam経由)―最初のステップは、アップデートされたビルドを作成し、Steam内でベータとして設定することです。 これにより、ユーザーが任意で参加する別バージョンのゲームがSteamで配信されます。このバージョンは任意でパスワード保護が可能です。
  2. ワークショップのベータ(グループ経由)―Steamコミュニティ内でグループを設定し、グループ内のメンバーシップを使用して、Steamワークショップへのアクセスを管理します。 アプリケーションを所有する全ユーザーに向けてアクセスを公開することも可能です。
    1. テスト用のSteamコミュニティグループを作る。 選ばれた人だけにアクセスを制限したい場合には非公開にしてください。
    2. そのグループのSteam IDを入手する。 グループから、「グループプロフィールを編集」をクリックすると、ページ上部でIDがわかります。 (例: 2667495)
    3. ゲームのSteamworks管理ページの「ワークショップ」タブの下で「一般」をクリックし、公開設定を「開発者とテスター」に設定。 グループのIDを入れて、 変更を公開する。
      workshopvisibilitystate.PNG

技術的実装

For technical details on implementing Steam Workshop with your title, please see the Steamワークショップ実装ガイド.

Frequently Asked Questions

Q. Can uploads be made from a game or tool via Family Sharing?
A. No, uploading to the Steam Workshop cannot be done by a user that has a temporary license for the game or tool that does the uploading. This means users cannot upload content if they only own your game via Family Sharing or via another temporary license such as a Free Weekend.