Documentation Steamworks
Steam Workshop
In Brief
Steam Workshop is a place for your fans and community members to participate in the creation of content for your game.
Level of integration
Fairly advanced, but depends on your usage. You'll need to create an upload path in your game or separate tool. Plus, either hand-integrating content into your game or making your game load downloaded mods from disc.

Présentation

The Steam Workshop is designed as a place for your fans and community members to participate in the creation of content for your game. 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 Guide d'implémentation de Steam Workshop.

Vidéo : introduction au contenu généré par les utilisateurs et au Steam Workshop.

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

Vidéo : contenu généré par les utilisateurs et Workshop dans ARK: Survival Evolved

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

Recommandations relatives à la marque Workshop

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 Recommandations relatives à la marque Steam.

Types de Workshops

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. Workshop prêt à l'emploi : tout le monde peut mettre du contenu en ligne, et les joueurs peuvent télécharger du contenu sans qu'aucune approbation soit nécessaire. C'est l'option la plus appropriée à la prise en charge d'un grand nombre d'objets, de mods ou de cartes dans votre jeu, que ces éléments soient de nature simple ou complexe. Vous devrez probablement travailler davantage en amont pour créer un éditeur ou un outil de validation approprié afin de vous assurer que le contenu créé fonctionnera correctement dans votre jeu. Les auteurs de ces objets pourront mettre leur contenu à jour à tout moment.

  2. Workshop approuvé : cette option est la plus adaptée pour conserver un contrôle plus strict sur les objets ajoutés et mis à disposition dans votre jeu, mais elle nécessite du travail et une mise à jour pour l'ajout de chaque objet dans votre jeu. Ce choix est généralement préférable pour les ensembles de contenu de moindre complexité et de taille réduite, comme les armes, les chapeaux et les autres accessoires. Si les objets sont vendus, un service de stockage permanent d'items (par exemple, le service d'inventaire Steam) doit être utilisé afin de conserver une trace des utilisateurs autorisés à se servir de ces objets en jeu, et un magasin doit être construit en jeu pour vendre ces objets. Leur prix est contrôlé par l'équipe de développement.

Workshop prêt à l'emploi

Pourquoi l'utiliser ?

  • Vous souhaitez prendre en charge un grand nombre d'objets. Un Workshop prêt à l'emploi facilite la prise en charge d'un grand nombre d'objets, de mods ou de cartes dans votre jeu, qu'ils soient de nature simple ou complexe. En construisant vos outils de création et d'édition à l'avance, vous permettez aux clients de pousser votre jeu plus loin.
  • Vous souhaitez que les auteurs puissent mettre leur contenu à jour à tout moment. Les créateurs d'objets prêts à l'emploi peuvent mettre à jour leurs objets, ce qui veut dire qu'ils peuvent éditer le contenu, corriger les bugs ou enrichir le contenu et l'expérience de leur mod ou objet.

Pour commencer

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.

Travail d'intégration

Here are some of the typical components to think about for integration of the Ready-To-Use Workshop model with your game:
  • Chargement du contenu dans le client d'un jeu solo : si vous prévoyez de rendre prêt à l'emploi le contenu proposé par les utilisateurs pour votre jeu, vous devrez structurer ce dernier de manière adéquate afin qu'il traite le contenu ainsi. Cela signifie généralement que votre jeu devra déterminer les fichiers à charger. Si vous mettez en œuvre une nouvelle implémentation, nous vous suggérons de faire en sorte que votre client de jeu consulte d'abord la liste des fichiers auxquels est abonné l'utilisateur Steam, puis qu'il charge les dossiers correspondants. Vous devrez également disposer d'une forme d'environnement de simulation afin que les créateurs de mods bénéficient d'un lieu où travailler sur leurs mods et puissent effectuer des chargements depuis ce répertoire.
  • Chargement du contenu dans le client d'un jeu multijoueur : si vous avez des objets ou du contenu qui sont nécessaires à plusieurs utilisateurs pour que le jeu fonctionne correctement, vous pouvez télécharger ces objets vers tous les clients qui ont besoin de cet objet particulier. Par exemple, si un utilisateur s'est abonné à une carte personnalisée sur le Workshop et qu'il invite ses contacts à rejoindre cette partie, votre jeu devrait être capable de reconnaitre qu'il s'agit d'une carte personnalisée et de télécharger le contenu du Workshop pour les autres utilisateurs avant que ces derniers puissent se connecter pleinement à cette partie.
  • Mise en ligne des entrées des créateurs d'objets : vous aurez besoin d'un outil pour que les créateurs d'objets puissent mettre en ligne leurs entrées sur votre Workshop à l'aide de l'API ISteamUGC. Cela peut aller d'un simple formulaire dans votre jeu à une application autonome. Comme les objets que vous acceptez doivent être prêts à l'emploi, votre outil de soumission ne devrait accepter que les formats de fichier que votre client de jeu s'attend à charger, accompagnés d'une image d'aperçu. En fonction du contenu que vous demandez aux auteurs de télécharger, vous pourriez avoir besoin de vos propres outils d'édition (c'est particulièrement nécessaire pour toute modification à grande échelle des paramètres de votre jeu, comme la logique de jeu, la jouabilité ou tout ce qui dépasse la modification des visuels existants). Par exemple, la plupart des jeux « moddables » ont publié leurs propres outils de développement afin que les auteurs de mods puissent utiliser les mêmes outils que l'équipe de développement. Ces outils peuvent également restreindre et valider le contenu soumis si vous désirez contrôler quels fichiers peuvent être écrasés ou quels aspects du jeu peuvent être modifiés, par exemple. Dans le cadre des informations que vous fournissez aux auteurs potentiels d'objets du Workshop, vous pourriez également vouloir créer un guide de style et sans doute un ensemble de recommandations sur le type de contenu que vous recherchez et celui que nous ne désirez pas voir publié.

    Vous trouverez des informations détaillées pour démarrer avec la portion Steam Workshop de l'API Steamworks dans le Guide d'implémentation de Steam Workshop.

Distribuer les objets aux utilisateurs

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 Guide d'implémentation de Steam Workshop). 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.

Workshop approuvé

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.

Pourquoi l'utiliser ?

The Curated Workshop model is useful for your game if you:
  • vous avez besoin d'assigner des attributs spécifiques à chaque objet. Si vous acceptez les objets tels que les armes via le Workshop, il peut être important pour vous de pouvoir assigner les attributs de l'arme, comme sa vitesse, sa puissance, ses dégâts, son temps de rechargement, etc. afin d'équilibrer au mieux le gameplay dans votre jeu.
  • vous souhaitez avoir un contrôle strict du contenu ajouté à votre jeu. En fonction de la manière dont vous avez configuré votre jeu, vous pouvez accepter les objets de deux façons différentes :
    • Téléchargement et compilation : si vous souhaitez télécharger les ressources sur votre machine locale et les inclure à vos dépôts de jeu. Cette option vous permet d'éditer ou de modifier l'objet si vous avez besoin de l'optimiser ou que vous désirez imposer des guides de style stricts à chacun de vos objets.
    • Téléchargement direct vers le client : si vous souhaitez que chaque objet accepté soit téléchargé directement vers les clients selon les besoins. Cette option permet aux créateurs d'objets de mettre à jour leurs créations afin d'en corriger les bugs.

Pour commencer

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 Guide d'implémentation de Steam Workshop). 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.

Travail d'intégration

Here are some of the typical components to think about for integration of the Curated Workshop model with your game:
  • Approbation des entrées des créateurs d'objets : vous aurez besoin d'un outil pour que les créateurs d'objets puissent mettre en ligne leurs entrées sur votre Workshop. Cela peut être un simple formulaire dans votre jeu ou une application autonome. Vous pouvez démarrer avec un outil de chargement de base qui se bornera à demander au créateur d'objet de sélectionner un fichier .zip et une image d'aperçu, ou vous pouvez mettre en place plus de validation dans votre processus de soumission. Par exemple, Team Fortress 2 a commencé avec un simple formulaire de soumission qui demandait à l'auteur de l'objet de choisir un fichier .zip et une image d'aperçu. Au fur et à mesure des itérations de ce processus, nous avons ajouté un environnement de test et une procédure de validation pour faciliter l'intégration du fichier soumis au Workshop dans le jeu.

    Dans le cadre des informations que vous fournissez aux auteurs potentiels d'objets du Workshop, pensez à créer un guide de style et, éventuellement, un ensemble de recommandations sur le type de contenu recherché ou indésirable.

    Une fois qu'un utilisateur a téléchargé un objet sur le Workshop à l'aide de votre outil de soumission, il est recommandé de rediriger l'utilisateur vers la page de l'objet qu'il vient de publier. Cette opération lui permet d'accepter tout accord qu'il n'a pas déjà accepté, comme l'accord de souscription Steam ou l'accord du Workshop.
  • Intégration de l'objet à votre jeu (optionnel) : si vous devez assigner des attributs spéciaux à un objet, comme les effets d'une arme ou toute autre caractéristique que le créateur ne peut définir pendant le téléchargement, vous devrez télécharger l'objet depuis le site Web du Workshop et inclure le contenu dans vos dépôts. Dans ce processus, vous devrez assigner tout attribut approprié et effectuer toutes les modifications nécessaires. La quantité de travail nécessaire à ce stade dépendra du degré de validation effectué par votre outil de soumission et de la qualité de contenu que vous recevrez des créateurs d'objets.
  • Ou téléchargement à la volée : si vous n'avez pas besoin de « nettoyer » les objets ou de définir les attributs spéciaux vous-même, vous pouvez effectuer des appels afin de récupérer directement les objets possédés depuis les serveurs de contenu du Workshop. Vous utiliserez ISteamInventory (si vous passez par le service d'inventaire Steam) pour obtenir une liste des objets possédés par l'utilisateur. Ensuite, pour chaque objet que possède l'utilisateur, vérifiez qu'il existe un objet du Workshop, puis :
  • Service d'inventaire et création de définitions d'objets : si vos objets doivent être vendus en jeu ou distribués de quelconque façon à un nombre limité d'utilisateurs, vous aurez besoin d'un serveur d'objets (ou devrez utiliser le service d'inventaire Steam) pour suivre la possession de chaque objet afin que votre jeu sache quels clients sont autorisés à s'en servir. Ce service d'inventaire sera également nécessaire pour vendre ces objets, gérer les drops aléatoires ou les autres évènements déclenchant des drops d'objets pour les utilisateurs.
  • Ajout de règles de paiement : une fois que vous serez prêt à vendre vos objets, Steam devra savoir quels objets du Workshop sont associés à telles définitions d'objet figurant dans votre serveur d'objets ou dans le service d'inventaire Steam. Ce lien permet d'établir des règles de paiement afin que Steam sache à quels utilisateurs allouer la portion appropriée des revenus issus de chaque vente de l'objet. Ainsi, lorsque votre service d'inventaire déclenche une vente via l'API des microtransactions de Steam, Steam saura quel objet du Workshop a été acheté et se chargera de calculer la bonne valeur des revenus et des paiements à verser au(x) créateurs de l'objet.

    Vous pouvez gérer vos règles de paiement en cliquant sur l'option « Saisir de nouvelles règles de paiement » sous l'onglet Workshop des paramètres Steamworks de votre application.

  • Vente d'objets : si vous prévoyez de disposer d'un magasin pour vendre ces objets, vous pouvez créer l'interface du magasin vous-même dans votre jeu ou utiliser le magasin d'objets Steam. Pour chaque achat, Steam s'occupera des détails de back end tels que :
    • recueillir et tenir à jour les informations bancaires et fiscales de chaque créateur d'objets du Workshop
    • calculer et émettre les paiements appropriés à destination de chaque créateur d'objets en fonction des objets vendus
    • effectuer les retenues d'impôt à la source nécessaires pour chaque créateur d'objet
    • envoyer en fin d'année les documents fiscaux nécessaires à chaque créateur d'objet.

Distribuer les objets aux clients

With the Curated Workshop model, there are a number of ways you can allow customers to get the items:
  • Vente dans un magasin en jeu via des microtransactions : si vous utilisez votre propre service d'inventaire, cette option nécessitera l'intégration de l'API des microtransactions Steam. À moins que vous ne passiez par le service d'inventaire Steam, qui inclut également un magasin d'objets personnalisable afin de référencer et vendre facilement les objets.
  • Drops aléatoires d'objets : cette option nécessitera un serveur d'objets (à moins que vous ne passiez par le service d'inventaire Steam) pour gérer les distributions et garder une trace du propriétaire de chaque objet.
  • En bundle dans un DLC : cette option implique généralement une infrastructure générale moins importante, mais vous demandera de déterminer les conditions de paiement de votre côté avec les contributeurs du Workshop. Pour chaque objet vendu comme DLC ou dans le cadre d'un DLC, vous devrez conclure votre propre accord avec les auteurs du Workshop quant à leur rémunération, soit un versement unique (plus simple) soit un pourcentage de royalties périodique (nécessite un travail régulier de votre part). Vous devrez également garder une trace de ces paiements et devrez peut-être calculer les retenues d'impôt nécessaires et émettre les formulaires fiscaux appropriés en fonction de votre lieu d'exercice.
  • Ajout des objets dans le jeu, gratuits pour tout le monde : cette option ne demande que l'infrastructure la plus minime, mais n'encouragera pas un très haut niveau de qualité dans les soumissions des auteurs d'objets.

Annonce et lancement

Supports marketing nécessaires

To prepare your Workshop for launch, you'll need to supply the following items:
  • Image d'entête du Workshop : cette image a pour but de faciliter l’identification de votre produit sur la page d’accueil. Nous mettons à votre disposition un modèle Photoshop à cet effet ici. Nous vous recommandons d’utiliser des aspects visuels de votre jeu facilement reconnaissables, de même que le logo de votre jeu. Veuillez laisser une zone neutre à droite, afin de pouvoir insérer un titre court et une description simple expliquant comment votre produit utilise le Steam Workshop.
  • Brève description : veuillez saisir un titre et une ou deux lignes de texte expliquant comment votre application utilise le Steam Workshop. Cela permettra aux utilisateurs de comprendre ce qu’ils y trouveront et comment utiliser vos outils.
  • Documentation pour vos outils : si vous disposez déjà, sur votre site Web ou un wiki, d'une documentation aidant les utilisateurs à bien démarrer sur vos outils, veuillez en saisir l'URL sur la page de configuration du Workshop de votre application. Sinon, vous pourriez envisager de rédiger un guide Steam de votre jeu afin de présenter aux nouveaux utilisateurs les outils utilisés pour créer du contenu sur votre Workshop.

Annonce de lancement et choix du moment

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 Remises 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 Visibilité sur 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. Il est possible de lancer une bêta fermée et d'y inviter un certain nombre d'utilisateurs si vous souhaitez réaliser des tests avec un petit groupe et générer du contenu en toute tranquillité avant le lancement. Vous trouverez plus d'informations sur l'exécution des versions bêta dans le paragraphe suivant, ci-dessous.
  2. Ou, vous pouvez choisir de créer quelques objets en interne afin de montrer ce qu'il est possible de faire avec vos outils.

Lancer une bêta fermée

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. Bêta de votre jeu (via Steam) : la première étape est de créer une version mise à jour de votre jeu et de la définir comme version bêta dans Steam. Ceci permet à Steam de proposer une version séparée de votre jeu que les clients doivent choisir d'utiliser et qui peut éventuellement être protégée par un mot de passe.
  2. Bêta de votre Workshop (via un groupe) : vous pouvez définir un groupe au sein de la communauté Steam et utiliser l'appartenance à ce groupe pour filtrer l'accès au Steam Workshop. À moins que vous ne décidiez d'ouvrir simplement l'accès à tous les clients qui possèdent votre application.
    1. Dans la communauté Steam, créez un groupe qui sera utilisé pour les tests. Vous désirerez peut-être le laisser en privé si vous prévoyez de restreindre l'accès à des personnes que vous souhaitez sélectionner.
    2. Récupérez le SteamID de ce groupe. Depuis ce groupe, cliquez sur « Modifier le profil du groupe » et repérez l'ID en haut de cette page (ex. : 2667495).
    3. In the Steamworks admin for your game, under the "Workshop" tab, click "General", then set the Visibility State to "Developers & Testers". On vous demandera de saisir l'ID du groupe de testeurs. Publiez vos changements.
      workshopvisibilitystate.PNG

Implémentation technique

For technical details on implementing Steam Workshop with your title, please see the Guide d'implémentation de Steam Workshop.

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.