Steamworks-dokumentation
Steam-værksted
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.

Oversigt

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 Implementeringsvejledning til Steam-værkstedet.

Video: Introduktion til brugerskabt indhold og Steam-værkstedet.

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

Video: UGC og værksted i 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

Retningslinjer for branding af værkstedet

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 Retningslinjer for Steam-branding.

Værkstedstyper

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. "Klar til brug"-værksted – Alle kan uploade indhold, og spillere kan downloade indhold uden nogen kuration. Dette er bedst egnet til at understøtte et større antal genstande, mods eller baner i dit spil, som har en simpel eller kompleks karakter. Du vil sandsynligvis være nødt til at arbejde forud for at lave et passende redigerings- eller valideringsværktøj for at sikre, at forfattet indhold vil fungere korrekt i dit spil. Forfattere af disse genstande vil være i stand til at opdatere deres indhold når som helst.

  2. Kurateret værksted – Dette er bedst til at have strammere kontrol med de genstande, som tilføjes og gøres tilgængelige i dit spil, men det kræver arbejde og en opdatering at tilføje hver genstand til spillet. Dette er typisk bedre for små og mindre komplekse stykker indhold såsom våben, hatte eller andre tilbehørsgenstande. Hvis disse genstande sælges, skal der bruges en lagertjeneste til vedvarende genstande (f.eks. Steam-inventartjenesten) til at holde styr på, hvilke brugere der har tilladelse til at udstyre genstande i spil, og der skal være indbygget en butik i spillet for at sælge genstande. Prisfastsættelse kontrolleres af udvikleren.

"Klar til brug"-værksted

Hvorfor bruge værkstedet?

  • Du ønsker at understøtte et større antal genstande. Et "klar til brug"-værksted gør det nemmere at understøtte et større antal genstande, mods eller baner i dit spil, som har en simpel eller kompleks karakter. Ved at bygge værktøjer til at skabe og redigere indhold på forhånd giver du kunderne mulighed for at gøre mere med dit spil.
  • Du ønsker, at forfattere skal kunne opdatere indhold når som helst. Forfattere af genstande, som er klar til brug, kan opdatere deres genstande, hvilket betyder, at de kan redigere indhold, rette fejl eller udvide indholdet og oplevelsen af deres mod eller genstand.

Sådan kommer du i gang

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.

Integrationsarbejde

Here are some of the typical components to think about for integration of the Ready-To-Use Workshop model with your game:
  • Indlæsning af indhold i en singleplayer-spilklient – Hvis din hensigt er, at indhold, som indsendes af kunder, skal være klar til brug i dit spil, skal du strukturere dit spil til at håndtere indhold på en passende måde. Typisk betyder dette, at dit spil skal søge efter filer, som skal indlæses. Hvis du bygger en ny implementering, foreslår vi, at din spilklient først søger efter Steams brugersliste over filer, der er abonnement på, og derefter indlæser de tilsvarende mapper. Du skal også have en eller anden form for iscenesættelsesmiljø, således at skabere af mods har et sted, hvor de kan arbejde på deres mods og kan loade fra den pågældende mappe.
  • Indlæsning af indhold i en multiplayer-spilklient – Hvis du har genstande eller indhold, som flere brugere har brug for, for at spillet fungerer korrekt, kan du hente disse genstande til alle klienter, der har brug for en bestemt genstand. Hvis en enkelt bruger for eksempel har abonneret på et brugerdefineret kort i værkstedet og derefter inviterer sine venner til at tilslutte sig kampen, bør dit spil være i stand til at se, at det er et brugerdefineret kort, og downloade indholdet fra værkstedet til de andre brugere, før der tilsluttes til kampen.
  • Upload af indlæg fra genstandsskabere – Du skal bruge et værktøj til genstandsskabere, for at de kan uploade deres indlæg til dit værksted ved at bruge ISteamUGC-API'en. Dette kan være så simpelt som en formular i dit spil, eller det kan være en selvstændig app. Da genstandene, som du accepterer, burde være klar til brug, bør dit indsendelsesværktøj kun acceptere filformaterne, som din spilklient kan læse, sammen med et forhåndsvisningsbillede. Afhængigt af, hvilket indhold du beder skabere om at uploade, kan det være, at du har brug for dine egne redigeringsværktøjer (særligt for store modifikationer af dit spil såsom spillogik, gameplay eller noget ud over ændringer til eksisterende grafik). For eksempel har de fleste spil, som kan modificeres, udgivet deres egne udviklerværktøjer, så mod-skabere kan bruge de samme værktøjer, som udvikleren har brugt. Disse værktøjer kan også begrænse og validere indhold, som bliver indsendt, hvis du ønsker at kontrollere ting, såsom hvilke filer der kan overskrives, eller hvilke aspekter af spillet der kan ændres. Som en del af de oplysninger, du giver til potentielle skabere af værkstedsgenstande, skal du også oprette en vejledning og muligvis et sæt retningslinjer om, hvilke typer af indhold du søger, og hvilke typer af indhold, du ikke ønsker at se.

    Se Implementeringsvejledning til Steam-værkstedet for detaljerede oplysninger om, hvordan du kommer i gang med at bruge Steam-værkstedsdelen af Steamworks-API'en.

Sådan får du genstande ud til kunder

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 Implementeringsvejledning til Steam-værkstedet). 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.

Kurateret værksted

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.

Hvorfor bruge værkstedet?

The Curated Workshop model is useful for your game if you:
  • Har brug for at tildele specifikke attributter til hver genstand. Hvis du accepterer genstande såsom våben via værkstedet, kan det være vigtigt for dig at være i stand til at tildele våbnets attributter såsom hastighed, styrke, skade, genopladningstid osv. for bedst at kunne balancere gameplayet i din titel.
  • Ønsker strammere kontrol over det indhold, som tilføjes til dit spil. Afhængigt af hvordan du opsætter dit spil, kan du acceptere genstande på to forskellige måder:
    • Download og byg – Hvis du ønsker at downloade resurserne til din lokale maskine og inkludere dem i dine spildepoter. Dette giver dig mulighed for at redigere eller ændre genstanden, hvis du har behov for at optimere den eller ønsker at pålægge strenge vejledninger til hver af dine genstande.
    • Direkte til klient – Hvis du ønsker, at hver accepteret genstand kan downloades direkte til klienter efter behov. Dette tillader, at skabere af genstande kan opdatere deres genstande for at afhjælpe fejl.

Sådan kommer du i gang

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 Implementeringsvejledning til Steam-værkstedet). 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.

Integrationsarbejde

Here are some of the typical components to think about for integration of the Curated Workshop model with your game:
  • Acceptere indlæg fra genstandsskabere – Du skal bruge et værktøj, for at genstandsskabere kan uploade deres indsendelser til dit værksted. Dette kan være så simpelt som en formular i dit spil, eller det kan være en selvstændig app. Du kan begynde med en grundlæggende uploader, som bare beder genstandsskaberen om at vælge en .zip-fil og et billede til forhåndsvisning, eller du kan bygge mere validering ind i indsendelsesstien. For eksempel begyndte Team Fortress 2 med bare at have en indsendelsesformular, som bad genstandsskaberen om at vælge en .zip-fil og et billede til forhåndsvisning. Men under vores iterationer af processen tilføjede vi et testmiljø og validering for at sikre, at det ville være nemmere at integrere den fil, der blev indsendt til værkstedet, i spillet.

    I din information til potentielle genstandsskabere vil det være godt at have en stilguide og evt. retningslinjer om, hvilken slags indhold du er interesseret i, og hvilken slags indhold du ikke ønsker, at brugere slår op.

    Når en bruger har uploadet en genstand til værkstedet fra dit indsendelsesværktøj, er det godt at føre brugeren til siden med den genstand, vedkommende netop har slået op. Dette gør det muligt for brugeren at acceptere aftaler, som vedkommende muligvis ikke allerede har accepteret, såsom Steam-abonnentaftalen eller værkstedsaftalen.
  • Integrering af genstanden i dit spil (valgfrit) – Hvis du har behov for at tildele særlige attributter til en genstand, såsom effekter til et våben eller noget andet, som skaberen ikke kan definere under upload, skal du downloade genstanden fra værkstedets hjemmeside og inkludere indholdet i dine depoter. Du skal hen ad vejen tildele de passende attributter og foretage eventuelle nødvendige ændringer. Mængden af arbejde i dette trin afhænger af, hvor meget validering dit overførselsværktøj udfører og kvaliteten af indholdet, som du får fra genstandsskabere.
  • Eller download på farten – Hvis du ikke har behov for at rydde op i genstande eller indstille særlige attributter til genstande selv, kan du lave kald for at få de ejede genstande direkte fra værkstedets indholdsservere. Du skal bruge ISteamInventory (hvis du bruger Steam-inventartjenesten) til at hente en liste over genstande, som brugeren ejer. For hver genstand, som brugeren ejer, skal du så tjekke for at se, om det er en værkstedsgenstand, og derefter:
  • Inventartjeneste og oprettelse af genstandsdefinitioner – Hvis dine genstande skal sælges i spillet eller på andre måder gives til et begrænset antal brugere, skal du have en genstandsserver (eller du kan bruge Steam-inventartjenesten) til at spore ejerskab af hver genstand, så dit spil ved, hvilken klient der skal have tilladelse til at udstyre genstanden. Inventartjenesten er også nødvendig for at sælge disse genstande eller for at administrere tilfældige drops eller andre begivenheder, som udløser genstandsdrops til kunder.
  • Tilføjelse af betalingsregler – Når du er klar til at begynde at sælge dine genstande, skal Steam vide, hvilke værkstedsgenstande er tilknyttet med hvilke genstandsdefinitioner i din genstandsserver eller i Steam-inventartjenesten. Dette link etablerer betalingsregler, så Steam ved, hvilke brugere skal tildeles den relevante del af indtægterne fra hvert salg af genstanden. Så når din inventartjeneste udløser et salg gennem Steam-mikrotransaktions-API'en, ved Steam, hvilken værkstedsgenstand der er blevet købt, og vil udføre de rette indtægtsudregninger og udbetalinger til skaberen af genstanden.

    Du kan administrere dine regler for udbetaling ved at klikke på "Indtast nye betalingsregler" under værkstedsfanen på Steamworks-indstillingsiden for din app.

  • Salg af genstande – Hvis du planlægger at have en butik til at sælge disse genstande, kan du oprette brugergrænsefladen til butikken selv indenfor dit eget spil, eller du kan gøre brug af Steam-genstandsbutikken. For hvert køb vil Steam tage sig af backend-detaljerne såsom:
    • Indsamling og opretholdelse af bank- og skatteoplysninger for hver skaber af værkstedsgenstande
    • Beregning og udstedelse af passende udbetalinger til hver genstandsskaber baseret på de solgte genstande
    • Tilbageholdelse af den nødvendige indkomstskat for hver genstandsskaber
    • Udstedelse af skattedokumenter for året til hver enkelt skaber

Sådan får du genstande ud til kunder

With the Curated Workshop model, there are a number of ways you can allow customers to get the items:
  • Solgt i en butik i spillet via mikrotransaktioner – Hvis du bruger din egen inventartjeneste, vil dette kræve integration med Steam-mikrotransaktions-API'en. Eller du kan bruge Steam-inventartjenesten, som også inkluderer en justerbar genstandsbutik til at sætte ting til salg på en nem måde.
  • Tilfældige genstandsdrops – Dette kræver en genstandsserver (eller du kan bruge Steam-inventartjenesten) til at administrere drops og føre regnskab med ejerskab af hver genstand.
  • I bundt som DLC – Dette involverer typisk mindre overordnet infrastruktur, men det vil kræve, at du selv udarbejder udbetalingsbetingelserne med bidragyderne i værkstedet. For hver genstand, som sælges som DLC eller som en del af et DLC, skal du lave din egen aftale med værkstedsskaberne om, hvor meget du skal udbetale til dem (enten et engangsbeløb (det nemmeste) eller en løbende licensprocent (kræver løbende arbejde fra din side). Du skal også holde styr på disse udbetalinger, og det kan være nødvendigt at udregne kildeskat og sende skatteformularer afhængigt af, hvor i verden du driver forretning.
  • Bare tilføj genstandene til spillet, gratis for alle – Dette kræver minimal infrastruktur, men det vil sikkert ikke motivere genstandsskaberne til indsendelser af høj kvalitet.

Annoncering og udgivelse

Nødvendige markedsføringsmaterialer

To prepare your Workshop for launch, you'll need to supply the following items:
  • Overskiftsbillede til værkstedet – Dette billede er beregnet til at give en følelse af genkendelighed for dit produkt på hjemmesiden. Vi har en Photoshop-skabelon til dette her. Billedet bør gøre brug af nogle illustrationer, som er genkendelige fra dine spil, såvel som dit spillogo. Lad højre side have lidt neutral plads til en kort overskrift og en sætning om, hvordan dit produkt gør brug af Steam-værkstedet.
  • Kort beskrivelse – Du bør skrive en titel og en eller to linjer, som beskriver, hvordan din applikation bruger Steam-værkstedet. Dette vil hjælpe med at afstemme kundernes forventninger til, hvad de kan finde, og hvordan de kan bruge dine værktøjer.
  • Dokumentation til dine værktøjer – Hvis du allerede har dokumentationen på din hjemmeside eller en wiki, som hjælper brugere med at komme i gang med dine værktøjer, bedes du skrive URL'en på værkstedets konfigurationsside til din app. Ellers kan du overveje at skabe en Steam-vejledning til dit spil for at introducere nye brugere til værktøjerne, som bruges til at skabe indhold til dit værksted.

Meddelelser om udgivelser og timing

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 Rabatter 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 Synlighed på 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. Det er muligt at køre en lukket beta og invitere et antal brugere ind, hvis du ønsker at teste med en lille gruppe og stille generere indhold før udgivelse. Flere oplysninger om at køre betaer kan findes i den næste sektion nedenfor.
  2. Eller du kan vælge at oprette et par genstande internt som en demonstration af, hvad der kan skabes med dine værktøjer.

Kørsel af en privat beta

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. Beta af dit spil (via Steam) – Det første skridt er at skabe et opdateret build af dit spil og indstille det som en beta i Steam. Dette gør det muligt for Steam at levere en separat version af dit spil, som kunder skal tilvælge, og den kan eventuelt være beskyttet med adgangskode.
  2. Beta af dit værksted (via gruppe) – Du kan opsætte en gruppe i Steam-fællesskabet og bruge medlemskab i den pågældende gruppe til at styre, hvem der har adgang til Steam-værkstedet. Eller du kan bare give adgang til alle kunder, som ejer din applikation.
    1. Opret en Steam-fællesskabsgruppe til at bruge til testformål. Det kan være, at du ønsker at gøre gruppen privat for at begrænse adgangen til folk, som du udvælger.
    2. Få Steam-ID'et fra gruppen. Fra gruppen skal du klikke på "Rediger gruppeprofil" og finde ID'et øverst på siden (for eksempel: 2667495)
    3. Under fanen "Værksted" i Steamworks-administratoren for dit spil skal du klikke på "Generelt" og derefter indstille "Synlighedstilstand" til "Udviklere og testere". Du vil blive bedt om at indtaste ID'et. Udgiv dine ændringer.
      workshopvisibilitystate.PNG

Teknisk implementering

For technical details on implementing Steam Workshop with your title, please see the Implementeringsvejledning til Steam-værkstedet.

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.