Documentación de 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.

Introducción

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 Guía de implantación de Steam Workshop.

Video: introducción al contenido generado por los usuarios y a Steam Workshop.

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

Video CGU y Workshop en 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

Directrices sobre el logotipo de 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 Directrices sobre logotipos de Steam.

Tipos de Workshop

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. Listo para usar: cualquiera puede cargar contenido y los jugadores pueden descargar contenido sin supervisión. Es más apropiado cuando hay un gran número de artículos, mods o mapas en el juego, ya sean de naturaleza simple o compleja. Es probable que se necesite más trabajo preparatorio para crear un editor o herramienta de validación apropiada que asegure que el contenido autorizado funciona adecuadamente en el juego. Los autores de estos artículos podrán actualizar su contenido en cualquier momento.

  2. Workshop supervisado: Es más adecuado para mantener un mejor control de los artículos ya añadidos y disponibles en el juego, aunque requiere trabajo y una actualización para añadir cada nuevo artículo al juego. Suele ser mejor para contenidos menores y menos complejos, como armas, sombreros y otros accesorios. Si estos artículos se venden, debe usarse un servicio de almacenamiento de artículos persistente, tal como el Servicio de inventario de Steam, para hacer el seguimiento de los usuarios que tienen autorización para equipar artículos dentro del juego, y debe crearse una tienda en el juego para vender artículos. Los precios los determina el desarrollador.

Workshop listo para usar

Por qué se usa

  • Para permitir un gran número de artículos. Un Workshop listo para usar hace más sencillo permitir un gran número de artículos, mods o mapas para el juego, ya sean de naturaleza simple o compleja. Al construir las herramientas de creación y edición se permite a los clientes hacer más cosas con su juego.
  • Se quiere que los autores puedan actualizar el contenido en cualquier momento. Los autores de artículos listos para usar pueden actualizar sus artículos, lo que significa que pueden editar contenido, arreglar errores o expandir el contenido y la experiencia de sus mods y artículos.

Primeros pasos

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.

Integración de Workshop

Here are some of the typical components to think about for integration of the Ready-To-Use Workshop model with your game:
  • Carga de contenido en un cliente de juego para un jugador: si quieres que el contenido enviado por los clientes esté listo para usar dentro de tu juego, necesitarás estructurar este de forma apropiada para que gestione el contenido de ese modo. Normalmente, eso significa que tu juego deberá comprobar los archivos a cargar. Si estás creando una nueva implementación, sugerimos que el cliente del juego compruebe primero la lista de archivos suscritos del usuario de Steam y que luego cargue las carpetas correspondientes. También es necesario disponer de alguna clase de entorno de preparación para que los creadores de mods tengan un lugar donde trabajar en sus mods y desde cuyo directorio puedan cargarlos.
  • Carga de contenido en un cliente de juego multijugador: si tienes artículos o contenido que múltiples usuarios necesitan para que el juego funcione adecuadamente, puedes descargar los artículos particulares en todos los clientes que lo precisen. Por ejemplo, si un jugador se suscribe a un mapa personalizado en Workshop e invita a sus amigos a unirse a la partida, el juego debe poder reconocer que se trata de un mapa personalizado y descargar el contenido desde Workshop para los demás usuarios antes de que se conecten.
  • Carga de entradas de autores de artículos: se necesita una herramienta para que los autores de artículos carguen sus entradas en tu Workshop mediante la API ISteamUGC. Puede ser tan sencilla como un formulario dentro del juego o una aplicación independiente. Como los artículos aceptados deben estar listos para usar, la herramienta de envío debe admitir únicamente los formatos de archivo que el cliente del juego espera, junto con una imagen de la vista previa. Dependiendo del contenido que se pida a los autores que carguen, puede que necesites tus propias herramientas de edición (especialmente en el caso de mods a gran escala del juego, con cambios en la lógica, el desarrollo o cualquier otra modificación más allá del aspecto visual existente). Por ejemplo, la mayoría de los juegos modificables publican sus propias herramientas de desarrollo, de modo que los autores de mods pueden emplear las mismas herramientas que los desarrolladores. Estas herramientas también pueden restringir y validar el contenido enviado si deseas controlar cosas como qué archivos pueden sobrescribirse o qué aspectos del juego pueden cambiarse. Como parte de la información que proporcionas a los posibles autores de artículos de Workshop, también es conveniente crear una guía de estilo y, tal vez, unas directrices sobre el tipo de contenido que buscas y el que no deseas ver publicado.

    Véase en Guía de implantación de Steam Workshop para información detallada acerca de cómo empezar a usar la parte de Steam Workshop de la API de SteamworksI.

Entrega de los artículos a los clientes

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 Guía de implantación 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 supervisado

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.

Por qué se usa

The Curated Workshop model is useful for your game if you:
  • Necesitas asignar atributos específicos a cada artículo. Si aceptas a través de Workshop artículos tales como armas, puede ser importante tener la capacidad de asignar atributos como velocidad, potencia, daño, tiempo de recarga, etc. para que el desarrollo del juego sea equilibrado.
  • Quieres un mayor control del contenido que se añade al juego. En función de cómo hayas configurado el juego, puedes aceptar artículos de dos formas distintas:
    • Descarga y compilación: Si quieres descargar los recursos en tu equipo local e incluirlos en tus repositorios del juego. Esto te da la oportunidad de editar o modificar el artículo si necesitas optimizarlo o si deseas imponer guías de estilo estrictas para cada uno de los artículos.
    • Directo al cliente: Si quieres que todos los artículos aceptados se descarguen directamente en los clientes cuando sea necesario. Esto permite a los autores de artículos actualizar sus creaciones para resolver errores.

Primeros pasos

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 Guía de implantación 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.

Integración de Workshop

Here are some of the typical components to think about for integration of the Curated Workshop model with your game:
  • Carga de entradas de autores de artículos: se necesita una herramienta para que los autores de artículos carguen sus entradas en tu Workshop. Puede ser tan sencilla como un formulario dentro del juego o una aplicación independiente. Puedes comenzar con un cargador básico que simplemente pida al creador del artículo que seleccione un archivo .zip y una imagen de la vista previa, o puedes integrar en esta ruta más pasos de validación. Por ejemplo, Team Fortress 2 comenzó con solo un formulario de envío que pedía al autor del artículo que eligiera un archivo .zip y una imagen de la vista previa. Con el tiempo, añadimos un entorno de prueba y validación para asegurarnos de que el archivo subido a Workshop fuera más fácil de integrar en el juego.
    Como parte de la información que proporcionas a los posibles autores de artículos de Workshop, también es conveniente crear una guía de estilo y, tal vez, unas directrices sobre el tipo de contenido que buscas y el que no deseas ver publicado.
    1>1>
    Una vez que un usuario ha cargado un artículo en Workshop mediante tu herramienta de envío, es recomendable llevar al usuario a la página del objeto recién publicado. Así podrán aceptar cualquier acuerdo que no haya aceptado previamente, como el Acuerdo de Suscriptor a Steam o el Acuerdo de Workshop.
  • Integración del artículo en el juego (opcional): si necesitas asignar atributos especiales a un artículo, como los efectos de un arma o cualquier otra cosa que el creador no haya podido definir durante la carga, deberás descargar el artículo desde el sitio web de Workshop e incluir el contenido en tus repositorios. También deberás asignar cualquier atributo apropiado y realizar las modificaciones necesarias. La cantidad de trabajo en este paso dependerá del grado de validación de la herramienta de envío y de la calidad del contenido que obtengas de los autores de artículos.
  • O bien, descarga al vuelo: si no necesitas limpiar artículos o establecer atributos especiales para ellos, puedes indicar que los artículos poseídos se obtengan directamente de los servidores de contenido de Workshop. Utilizarás ISteamInventory (si empleas el servicio de inventario de Steam) para obtener una lista de los artículos que posee el usuario. A continuación, para cada artículo en propiedad del usuario se comprueba si es un artículo de Workshop y entonces:
  • Servicio de inventario y creación de definiciones de artículos: si tus artículos se van a vender en el juego o se van a conceder a un número limitado de usuarios, necesitarás un servidor de artículos (o puedes utilizar el servicio de inventario de Steam) para realizar un seguimiento de la propiedad de cada artículo, de modo que el juego sepa qué clientes tienen permiso para equiparlos. Este servicio de inventario también será necesario para vender los artículos o para gestionar los obtenidos al azar en combate o por eventos que activen la obtención de artículos por parte de los clientes.
  • Agregación de normas de pago: cuando estés listo para empezar a vender tus artículos, Steam necesitará saber qué artículos de Workshop corresponden a cada definición en tu servidor de artículos o en el servicio de inventario de Steam. Este enlace establece las reglas de pago, para que Steam sepa cómo repartir entre los distintos usuarios los ingresos generados por cada artículo vendido. Así, cuando tu servicio de inventario active una venta a través de la API de microtransacciones de Steam, el servicio sabrá qué artículo de Workshop se ha comprado y se encargará de calcular los ingresos que corresponden a su autor o autores y pagárselos.

    Puedes administrar tus reglas de pago dando clic en la opción de "Introducir nuevas reglas de pago" bajo la pestaña del Workshop en la página de parámetros de Steamworks de tu aplicación.

  • Vender los artículos: si quieres organizar una tienda para la venta de los artículos, puedes crear la IU tú mismo, dentro del propio juego, o puedes utilizar la tienda de artículos de Steam. Para cada operación, Steam se ocupará de los detalles del backend, como:
    • Recoger y almacenar los datos bancarios y fiscales del creador de cada artículo de Workshop.
    • Calcular lo que se debe al creador de cada artículo por los artículos vendidos.
    • Retener al creador de cada artículo las cantidades en concepto de impuesto sobre la renta.
    • Enviar al final del ejercicio la documentación fiscal correspondiente al creador de cada artículo.

Entrega de los artículos a los clientes

With the Curated Workshop model, there are a number of ways you can allow customers to get the items:
  • Microtransacciones de una tienda integrada en el juego: si utilizas tu propio servicio de inventario, tendrás que integrarlo a su vez con la API de microtransacciones de Steam. O puedes usar el servicio de inventario de Steam, que incluye una tienda personalizable donde resulta muy sencillo poner tus artículos a la venta.
  • Aparición de artículos aleatorios: esto requiere un servidor de artículos (o usar el servicio de inventario de Steam) para gestionar su aparición y mantener un registro con los propietarios de cada artículo.
  • En pack como DLC: por lo general, esto requiere menos infraestructura, pero te obliga a gestionar tú mismo las condiciones de pago para los contribuyentes del Workshop. Para cada artículo vendido como DLC o dentro de un DLC, tendrás que acordar con el autor cuánto le vas a pagar (sea con un pago único, que es un sistema más cómodo, o mediante un sistema de royalties porcentuales, que requiere más trabajo por tu parte). También tendrás que someter dichos pagos a un seguimiento y, según donde realices tu actividad, puede que debas calcular las retenciones fiscales y emitir la correspondiente documentación fiscal.
  • Meter los artículos en el juego sin más, porque son gratuitos: Esta opción requiere una mínima infraestructura, pero es muy probable que no atraiga artículos de gran calidad.

Anuncios y lanzamientos

Materiales de marketing necesarios

To prepare your Workshop for launch, you'll need to supply the following items:
  • Imagen de cabecera para Workshop: esta imagen sirve para dar a la página principal un aire reconocible, asociado al producto. Puedes encontrar aquí una plantilla de Photoshop para esto aquí. Conviene que utilice artwork reconocible de tu juego, así como el logotipo de este. Deja algo de espacio a la derecha para poner un breve título y una frase sobre el uso que hace tu producto de Steam Workshop.
  • Descripción breve: escribe un título y una o dos líneas de texto acerca del modo en que tu aplicación utiliza Steam Workshop. Esto contribuirá a formar las expectativas del usuario sobre lo que se va a encontrar y cómo podrá usar tus herramientas.
  • Documentación sobre tus herramientas: si dispones ya de documentación en tu sitio web o de una wiki que ayude a los usuarios a empezar a usar tus herramientas, incluye la dirección URL en la página de configuración de Workshop de tu aplicación. Si no, siempre puedes plantearte crear una guía de Steam para tu juego en la que presentes a los nuevos usuarios las herramientas que se usan en la creación de contenido para tu Workshop.

Plazos y anuncios de los lanzamientos

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 Descuentos 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 Visibilidad en 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. Si quieres realizar pruebas con un grupo reducido y generar contenidos antes del lanzamiento sin darle publicidad, puedes organizar una beta cerrada e invitar a un pequeño grupo de usuarios. Tienes más información sobre la organización de betas en el siguiente tema más adelante.
  2. También puedes optar por crear algunos artículos internamente para demostrar lo que se puede hacer con las herramientas.

Organizar una beta privada

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 del juego (vía Steam): el primer paso es crear una compilación actualizada de tu juego y definirla como beta en Steam. Esto permite a Steam ofrecer una versión distinta del juego que los usuarios tendrán que elegir si desean usarla y que puede estar protegida con una contraseña.
  2. Beta de tu Workshop (vía grupo): puedes crear un grupo en la Comunidad Steam y usarlo como requisito para acceder a Steam Workshop. O puedes abrir las puertas a todos los usuarios que tengan tu aplicación.
    1. Crea un grupo de pruebas en la Comunidad Steam. Si quieres que solo pueda acceder la gente que tú elijas, conviene que lo definas como privado.
    2. Obtén el id. de Steam del grupo. Desde el grupo, haz clic en "Editar perfil" del grupo y busca su "id." en la parte superior de la página (ej.: 2667495).
    3. En el administrador de Steamworks para tu juego, en la sección "Workshop", haz clic en "General", luego configura el estado de visibilidad en "Desarrolladores y Probadores". Se te pedirá que pongas esa id. Publica tus cambios.
      workshopvisibilitystate.PNG.

Implementación técnica

For technical details on implementing Steam Workshop with your title, please see the Guía de implantación 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.