Documentação do Steamworks
Steam Workshop
Resumo
O Steam Workshop é um local para os seus fãs e membros da sua comunidade participarem na criação de conteúdo para o seu jogo.
Nível de integração
Relativamente avançado, mas depende da sua utilização. Terá de criar um método de envio de conteúdo a partir do seu jogo ou de uma ferramenta separada. Além disso, terá de integrar manualmente o conteúdo no seu jogo ou fazer com que carregue mods descarregados.

Vista geral

O Steam Workshop foi concebido como um local para os seus fãs e membros da sua comunidade participarem na criação de conteúdo para o seu jogo. Esta forma de criação por membros comunitários pode variar dependendo da natureza do seu jogo e do tipo de controlo que gostaria de ter sobre o respetivo conteúdo.

A presente página foi pensada como uma vista geral do Steam Workshop e dos diferentes modelos disponíveis. Para detalhes técnicos sobre a implementação do Steam Workshop no seu jogo, consulte: Guia de implementação do Steam Workshop.

Vídeo – Introdução a conteúdo gerado por utilizadores e ao Steam Workshop

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

Vídeo – Conteúdo gerado por utilizadores e Steam Workshop no Ark: Survival Evolved

Segue-se uma palestra de Jeremy Stieglitz (Studio Wildcard) no Steam Dev Days de 2016, sobre como a utilização de conteúdo gerado por utilizadores através do Steam Workshop ajudou a criar uma comunidade estável e proativa no jogo ARK: Survival Evolved. A palestra também aborda alguns dos passos técnicos e de design tomados para alcançar este objetivo.
https://www.youtube.com/watch?v=faweKXUTKgQ

Diretrizes da marca do Steam Workshop

Pode utilizar a marca do Steam Workshop para promover o seu Workshop. Clique aqui para fazer o download dos recursos gráficos da marca do Steam Workshop. Para mais informações sobre marcas gerais do Steam, consulte: Diretrizes de marcas do Steam.

Tipos de Workshop

Existem dois tipos principais de integração do Steam Workshop. Cada um tem os seus prós e contras, logo deve pensar bem na opção que faz mais sentido para o seu produto.
  1. Workshop com conteúdo pronto a usar – Qualquer utilizador pode enviar conteúdo e os jogadores podem fazer download do conteúdo diretamente. Recomendado para disponibilizar um maior número de itens, mods ou mapas no seu jogo, sejam eles simples ou complexos. Provavelmente terá de preparar uma ferramenta de validação ou um editor apropriado para garantir que o conteúdo criado funcione devidamente no seu jogo. Os autores destes itens poderão atualizá-los a qualquer momento.

  2. Workshop com curadoria – Recomendado caso queira manter um controlo mais firme sobre os itens adicionados e disponibilizados no seu jogo. Contudo, requer trabalho adicional e uma atualização para adicionar cada item ao seu jogo. Esta opção é normalmente a melhor para tipos de conteúdo mais pequenos e menos complexos, como armas, chapéus ou outros itens usados como acessórios. Se estes itens forem vendidos, será necessário usar um serviço de armazenamento persistente de itens (como o Serviço de Inventário Steam) para registar quais utilizadores têm autorização para equipar quais itens no jogo. Também será necessário criar uma loja dentro do jogo para vender os itens. Os preços são controlados pelo developer.

Workshop com conteúdo pronto a usar

Escolha o modelo de Workshop com conteúdo pronto a usar:

  • Caso queira disponibilizar um grande número de itens. Um Workshop com conteúdo pronto a usar facilita a disponibilização de um grande número de itens, mods ou mapas no seu jogo, sejam eles simples ou complexos. Ao disponibilizar as ferramentas de criação e de edição, irá permitir que os utilizadores façam mais com o seu jogo.
  • Caso queira que os autores atualizem as respetivas criações sempre que quiserem. Os autores de itens prontos a usar podem atualizar os itens que criarem, o que significa que podem editar conteúdo, corrigir bugs ou melhorar o conteúdo e a experiência do mod/item.

Primeiros passos

A melhor forma de começar é pensar no tipo de conteúdo que é mais adequado para os utilizadores criarem e expandirem o seu jogo. Por exemplo, jogos multijogador podem ter tipos de conteúdo que não fazem sentido em jogos para um só jogador. Assim que se decidir, terá de pensar na forma como o jogador irá carregar o conteúdo e no tipo de ferramentas necessárias para que os utilizadores criem conteúdo. Se o seu jogo for muito popular entre os jogadores, a comunidade irá descobrir formas de criar conteúdo para o jogo. No entanto, como mencionado antes, se quiser permitir a criação de mods em larga escala para o jogo, será útil disponibilizar o máximo possível de ferramentas de desenvolvimento para ajudar na criação de conteúdo e modificação da lógica do jogo.

Assim que tiver preparado o sistema básico de criação de mods, terá de integrar a API ISteamUGC para que o seu jogo possa saber quais os ficheiros do Workshop que o utilizador subscreveu e que pode descarregar conforme necessário. Depois, ativar a opção de venda de itens neste ambiente é fácil. O Steam Workshop trata da parte de pedir os dados bancários e fiscais dos autores, oferece as ferramentas para especificar os preços, apresenta os acordos necessários e lida com todo o processamento de pagamentos e retenções de impostos. O seu jogo só precisa de saber que ficheiros carregar na respetiva aplicação.

Integração

Seguem-se alguns dos componentes comuns da integração do modelo do Workshop com conteúdo pronto a usar:
  • Carregamento de conteúdo num jogo para um só jogador – Se pretende que conteúdo enviado por utilizadores esteja disponível para uso no seu jogo, terá de o estruturar devidamente para que o conteúdo possa seja gerido dessa forma. Normalmente, isto significa que o seu jogo terá de verificar quais ficheiros carregar. Caso esteja a implementar este sistema pela primeira vez, sugerimos que o jogo verifique primeiro a lista de ficheiros subscritos do utilizador e depois carregue as pastas correspondentes. Também será necessário que tenha algum tipo de ambiente de desenvolvimento para que os criadores de mods tenham um sítio para trabalhar e acesso a um diretório do qual poderão carregar ficheiros para testes no jogo.
  • Carregamento de conteúdo num jogo multijogador – Se tiver itens ou conteúdo de que vários utilizadores necessitam para que o jogo funcione devidamente, pode fazer com que todos os clientes descarreguem os itens. Por exemplo, se um utilizador subscreveu um mapa personalizado no Workshop e depois convidar amigos para jogarem na partida, o seu jogo terá de reconhecer que se trata de um mapa personalizado e fazer com que os outros utilizadores descarreguem o conteúdo do Workshop antes de se conectarem à partida.
  • Envio de conteúdo de utilizadores – Irá precisar de uma ferramenta para que os utilizadores enviem itens para o seu Workshop através da API ISteamUGC. Esta ferramenta pode ser algo tão simples como um formulário no jogo, mas também pode ser uma aplicação separada. Como os itens que quer aceitar deverão ser prontos a usar, a sua ferramenta de envio deverá aceitar apenas os formatos que o jogo espera carregar, junto de uma imagem de pré-visualização. Dependendo do conteúdo de que está à espera, poderá precisar de desenvolver e disponibilizar ferramentas de edição (necessárias especialmente para a modificação em larga escala do seu jogo, como da lógica, da jogabilidade ou mais do que a simples edição de elementos visuais existentes). Por exemplo, muitos jogos modificáveis disponibilizaram ferramentas de desenvolvimento próprias para que os autores de mods possam utilizar as mesmas ferramentas usadas pelos developers. Estas ferramentas também podem restringir e validar o conteúdo a ser enviado, caso queira controlar aspetos como os ficheiros que podem ser substituídos ou as partes do jogo que podem ser alteradas. Além das informações que fornecer aos criadores de itens do Workshop, também recomendamos que crie um guia de estilo e até um conjunto de diretrizes sobre os tipos de conteúdo que deseja ver publicados e os que não permite no Workshop.

    Consulte o Guia de implementação do Steam Workshop para informações detalhadas sobre como começar a parte do Steam Workshop da API do Steamworks.

Disponibilização de itens aos utilizadores

Com o modelo de conteúdo pronto a usar, os itens listados no Workshop estarão disponíveis de imediato para subscrição (se gratuitos) ou compra (se pagos) e serão descarregados automaticamente através da aplicação Steam (é necessária a integração da API ISteamUGC no seu produto para que este processo funcione de modo correto. Consulte a documentação técnica no Guia de implementação do Steam Workshop). O Steam Workshop irá tentar garantir que o utilizador tenha sempre a versão mais recente de cada mod que subscreveu. Se o mod foi comprado, o Steam trata da compra do item, do processamento de pagamentos, dos pagamentos aos autores, dos pagamentos ao developer do jogo e de quaisquer retenções de impostos necessárias.

Se quiser, pode criar um menu do Workshop no seu jogo para listar os mesmos itens.

Workshop com curadoria

A característica fulcral de um Workshop com curadoria é que, enquanto developer, terá de aprovar cada item e é provável que precise de um servidor de itens (ou usar o Serviço de Inventário Steam) para manter um registo dos proprietários dos itens. Este processo permite um nível elevado de controlo sobre os itens adicionados ao seu jogo, mas costuma requerer passos adicionais para aceitar cada item novo.

Num Workshop com curadoria, os itens publicados não são disponibilizados para utilização direta pelos outros utilizadores. Em vez disso, são apresentados numa fila e os utilizadores podem votar nos itens de que gostarem mais. Esta votação fornece-lhe dados sobre os itens que são mais desejados pelos utilizadores e ajuda a excluir projetos incompletos ou inapropriados.

Porquê usar um Workshop com curadoria?

O modelo de Workshop com curadoria de conteúdo é útil para o seu jogo:
  • Caso precise de definir atributos específicos para cada item. Se estiver a aceitar itens (como armas) através do Workshop, é importante poder definir os respetivos atributos (como a velocidade, a potência, o dano ou o tempo para recarregar, por exemplo) para melhor equilibrar a jogabilidade do seu jogo.
  • Caso queira um maior controlo sobre o conteúdo adicionado ao seu jogo. Dependendo de como o seu jogo foi configurado, pode aceitar itens de duas formas diferentes:
    • Download e implementação do conteúdo – Se quiser descarregar os recursos para o seu computador local e incluí-los nos depots do jogo. Este método permite-lhe editar ou modificar o item se precisar de o otimizar ou quiser impor diretrizes estilísticas em cada um dos itens.
    • Direto ao cliente – Se quiser que cada item aceite seja descarregado diretamente pelo cliente conforme necessário. Este método permite aos criadores de itens atualizar as respetivas criações para corrigir bugs.

Primeiros passos

Comece por configurar a página do seu Workshop com curadoria, incluir um formulário simples no seu jogo e publicar diretrizes/guias de estilo para potenciais criadores de itens. De forma a enviar conteúdo para o Workshop, terá de integrar a API ISteamUGC (consulte o Guia de implementação do Steam Workshop). Isto irá permitir que os criadores de itens comecem a explorar ideias e a publicar itens no Workshop para que sejam avaliados pela comunidade. Sugerimos que peça aos criadores de itens para publicarem apenas itens finalizados no Workshop. Se permitir que os utilizadores publiquem trabalhos incompletos ou apenas conceitos, terá de desenvolver um processo para transformar esses conceitos em itens reais, o que se torna difícil quando muitos itens estão envolvidos.

Assim que o seu Workshop estiver disponível, poderá começar a trabalhar na integração da API de microtransações do Steam e o Serviço de Inventário Steam para preparar a venda de itens aceites. Quando a sua loja estiver disponível para o público, poderá começar a aceitar itens, a definir regras de pagamento e a vender esses itens.

Integração

Seguem-se alguns dos componentes comuns da integração do modelo do Workshop com curadoria:
  • Aceitação de conteúdo de utilizadores – Irá precisar de uma ferramenta para que os utilizadores enviem itens para o seu Workshop. Esta ferramenta pode ser algo tão simples como um formulário no jogo, mas também pode ser uma aplicação separada. Pode começar com uma ferramenta básica de envio (que só pede ao autor para selecionar um ficheiro .zip e uma imagem de pré-visualização) ou pode integrar sistemas de validação no seu processo de envio de conteúdo. Por exemplo, o Team Fortress 2 começou com apenas um formulário que pedia um ficheiro .zip e uma imagem de pré-visualização, como descrito na frase anterior. Porém, à medida que melhorávamos o processo, adicionámos um ambiente para testes e validações para garantir que o ficheiro enviado para o Workshop seja mais fácil de integrar no jogo.

    Além das informações que fornecer aos criadores de itens do Workshop, também recomendamos que crie um guia de estilo e até um conjunto de diretrizes sobre os tipos de conteúdo que deseja ver publicados e os que não permite no Workshop.

    Após um utilizador enviar um item para o Workshop com a sua ferramenta, é aconselhável que o reencaminhe para a página do item que acabou de publicar. Deste modo, o utilizador pode aceitar acordos ainda pendentes, como o Acordo de Subscrição Steam ou o Acordo do Workshop.
  • Integração do item no seu jogo (opcional) – Caso precise de definir atributos especiais de um item, como os efeitos de uma arma ou qualquer outra característica que o criador não possa definir durante o envio, terá de fazer o download do item do site do Workshop e incluir o conteúdo nos seus depots. Durante o processo, terá de atribuir os atributos apropriados e realizar as alterações necessárias. A quantidade de trabalho neste passo irá depender das validações realizadas pela ferramenta de envio e da qualidade do conteúdo dos criadores de itens.
  • Ou download de conteúdo sob demanda – Se não precisar de editar itens ou de definir atributos especiais, pode chamar funções para obter os itens dos utilizadores diretamente dos servidores de conteúdo do Workshop. Use ISteamInventory (se estiver a usar o Serviço de Inventário Steam) e obtenha uma lista dos itens na posse do utilizador. Depois, para cada item, verifique se é um item do Workshop e, nesse caso:
  • Serviço de inventário e criação de definições de itens – Se pretende que os itens sejam vendidos dentro do jogo ou concedidos de outro modo a um número limitado de utilizadores, terá de usar um servidor de itens (ou usar o Serviço de Inventário Steam) para que os proprietários de cada item fiquem em registo e o seu jogo saiba quais os clientes com permissão para equipar quais itens. Este serviço de inventário também será necessário para vender os itens e para gerir distribuições aleatórias ou outros eventos que concedam itens aos utilizadores.
  • Adição de regras de pagamento – Assim que tiver feito os preparativos para começar a vender itens, o Steam irá precisar de saber quais itens do Workshop estão associados a quais definições de itens no seu servidor de itens ou no Serviço de Inventário Steam. Esta associação estabelece regras de pagamento para que o Steam saiba a quais utilizadores alocar a parte apropriada das receitas provenientes de cada venda do item. Desta forma, quando o seu serviço de inventário acionar uma venda através da API de microtransações do Steam, o Steam irá saber qual item do Workshop foi comprado e irá tratar do cálculo correto das receitas e pagamentos ao(s) autor(es) desse item.

    Pode gerir as suas regras de pagamento através da opção "Introduzir novas regras de pagamento" na secção "Workshop" da página de definições da sua aplicação no Steamworks.

  • Venda de itens – Se planeia ter uma loja onde vender estes itens, pode criar uma interface para a loja no jogo ou usar a loja de itens do Steam. Para cada compra, o Steam irá tratar de detalhes de back‑end, como:
    • A recolha e o armazenamento de informações bancárias e fiscais de cada autor de itens do Workshop.
    • O cálculo e a emissão de pagamentos apropriados a cada autor de acordo com os itens vendidos.
    • A retenção de impostos sobre rendimento necessários para cada autor.
    • A emissão de documentos fiscais no fim do ano para cada autor.

Disponibilização de itens aos utilizadores

Com o modelo de Workshop com curadoria, há vários métodos para permitir que os utilizadores tenham acesso aos itens:
  • Itens vendidos numa loja dentro do jogo, através de microtransações – Se estiver a usar o seu próprio serviço de inventário, este método irá necessitar de integração com a API de microtransações do Steam. Como alternativa, use o Serviço de Inventário Steam, que inclui uma loja de itens personalizável com a qual poderá listar e vender itens facilmente.
  • Distribuição aleatória de itens – Requer um servidor de itens (ou use o Serviço de Inventário Steam) para fazer a gestão das distribuições e manter um registo dos proprietários de cada item.
  • Como parte de DLC – Este método costuma precisar de menos infraestrutura, mas requer que negocie os termos de pagamento diretamente com os criadores de itens do Workshop. Para cada item vendido como DLC ou parte de um DLC, terá de chegar a um acordo com o respetivo autor acerca de como lhe irá pagar: ou através de um pagamento único (a opção mais fácil) ou através de "royalties" com base numa percentagem das receitas (a opção que requer um esforço contínuo da sua parte). Também terá de acompanhar estes pagamentos, calcular retenções de impostos necessárias e emitir as declarações de impostos apropriadas dependendo de onde a sua atividade comercial estiver situada.
  • Ao adicionar os itens gratuitamente para todos os jogadores – Este método requer o mínimo de infraestrutura, mas é provável que não incentive os criadores de itens a criar conteúdo de alta qualidade.

Anúncio e lançamento

Materiais de marketing necessários

Para preparar o lançamento do seu Workshop, terá de fornecer o seguinte:
  • Imagem de cabeçalho para o Workshop – Esta imagem é pensada para dar um aspeto reconhecível relacionado com o seu produto na página inicial. Use este ficheiro de modelo para Photoshop como base. Deve ser usada uma imagem familiar do seu jogo e o respetivo logótipo. Deixe algum espaço neutro no lado direito para um título e parágrafo breves sobre como o seu produto usa o Steam Workshop.
  • Descrição breve – Escreva um título e uma ou duas linhas de texto sobre como a sua aplicação usa o Steam Workshop para que os utilizadores tenham uma ideia do que irão encontrar e como poderão usar as suas ferramentas.
  • Documentação das ferramentas – Caso já tenha documentação no seu site ou Wiki para ajudar utilizadores a saber mais sobre as suas ferramentas, introduza o URL na página de configuração do Workshop da sua aplicação. Caso contrário, crie um Guia Steam para que novos utilizadores se familiarizem com as ferramentas usadas na criação de conteúdo para o seu Workshop.

Anúncio e período do lançamento

Quando lançar a integração do Workshop, é uma boa ideia vender o seu jogo com desconto para tirar partido de toda a atenção que o novo Workshop estiver a ter e incentivar o maior número possível de novos jogadores a usá‑lo. Pode configurar o seu próprio desconto para que coincida com o período de lançamento do Workshop. Para mais detalhes, consulte a documentação sobre Descontos.

Além disso, pode usar uma ronda de visibilidade de atualização para que o jogo apareça na página inicial da Loja Steam e assim promover o novo Workshop e promoção (caso tenha decidido aplicar um desconto). Para mais informações sobre rondas de visibilidade, consulte a documentação sobre Visibilidade no Steam.

Se publicar um grande anúncio sobre o Workshop como ferramenta de marketing, é importante para possíveis interessados que o Workshop do seu jogo já tenha conteúdo disponível. Desta forma, novos utilizadores terão uma ideia melhor do que o seu jogo se trata e a impressão de que existe uma comunidade ativa e dedicada. Além disso, os utilizadores existentes terão algo prático para fazer de imediato e os criadores de conteúdo irão ver o tipo de coisas que poderão criar para o seu Workshop. Pelo menos um item terá de ser publicado no seu Workshop para que o seu jogo apareça na lista da página inicial do Steam Workshop.

Para que o seu Workshop tenha conteúdo disponível no momento do lançamento, há duas formas possíveis de o fazer:
  1. É possível disponibilizar um programa beta fechado e convidar alguns utilizadores caso queira testar o Workshop com um grupo pequeno e gerar conteúdo em privado antes do lançamento. Pode encontrar mais informações sobre programas beta na secção abaixo.
  2. Outra opção é criar alguns itens internamente como uma demonstração do que pode ser criado com as suas ferramentas.

Beta privada

O Steam e o Steam Workshop facilitam a disponibilização de um programa beta privado para permitir que um grupo de utilizadores possa testar antecipadamente as suas novas ferramentas e a integração com o Workshop. Esta iniciativa é excelente para reunir feedback sobre o fluxo de criação de conteúdo e publicação e para lhe permitir lançar o seu Workshop com uma coleção de itens prontos para utilização pelos fãs.

O processo tem duas partes:
  1. Beta do seu jogo (via Steam) – O primeiro passo é criar uma build atualizada do seu jogo e defini-la como uma versão beta no Steam. Tal permite ao Steam disponibilizar uma versão separada do jogo que só poderá ser descarregada mediante uma confirmação por parte do utilizador e cujo acesso poderá ser protegido por palavra‑passe.
  2. Beta do seu Workshop (via grupo) – Pode configurar um grupo na Comunidade Steam e fazer com que apenas membros desse grupo possam aceder ao Steam Workshop do seu jogo. Em alternativa, também pode simplesmente conceder acesso a todos os utilizadores que tiverem a aplicação.
    1. Crie um grupo na Comunidade Steam para testes. Mantenha-o privado caso queira que apenas pessoas específicas tenham acesso.
    2. Copie o ID do grupo: no perfil do grupo, clique em "Editar perfil do grupo" e copie o "ID" no topo dessa página (por exemplo, 2667495).
    3. Na página de administração do seu jogo no Steamworks, passe o cursor pelo separador "Workshop", clique em "Geral" e, na secção "Estado de visibilidade", selecione "Developers e jogadores de teste". Ser-lhe-á pedido para introduzir o ID do grupo. De seguida, publique as alterações.
      workshopvisibilitystate.PNG

Implementação técnica

Para detalhes técnicos sobre a implementação do Steam Workshop no seu jogo, consulte: Guia de implementação do Steam Workshop.

Perguntas frequentes

P.: Tenho acesso a um determinado jogo ou ferramenta graças à Partilha de Biblioteca Steam. Posso usar esse jogo ou ferramenta para enviar itens?
R.: Não. Utilizadores com uma licença temporária do jogo ou ferramenta não podem enviar conteúdo para o Steam Workshop, o que significa que os utilizadores não podem enviar conteúdo se só tiverem o seu jogo via Partilha de Biblioteca ou se tiverem outro tipo de licença temporária, como um Fim de Semana Grátis.