Game export – Ylands

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Text replacement - "[[Ylands " to "[[Ylands:")
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
=Overview=
=Overview=
As of 0.12, Genesys projects (games made in Editor) cannot be played from Main menu directly any more. Before doing so, game has to exported from Editor. In similar fashion, before uploading a game to Workshop, the game has to be also exported using "Workshop export".
In order to publish and play Genesys projects (games made in Editor), they have to be exported from Editor and uploaded to Workshop. Workshop is the primary way how to distribute custom games, both single player and multiplayer, among other players. Its is also possible to export and play games locally, but this is primary intended for testing purposes.  


*'''Local export''' → creates local playable version of Genesys project.
To export a game see '''Export Game''' in editor menu
*'''Workshop export''' → creates workshop version of Genesys project.
*'''Workshop export''' → optimize the game and create workshop version of Genesys project
*'''Optimise''' → it is also possible to optimise the game in advance, so that the export will take less time
*'''Show Workshop files''' → opens folder with exported games


In this export process, two things are happening:
=== PC vs Universal games ===
It is possible to determine target platform of a game. This is specified in Game settings / Common settings
*'''PC only''' → when checked, the game could be run without limitations but only on PC
*'''Universal''' → universal games can be run on both PC and mobile devices, but their play areas is limited by maximum terrain size of 3x3x3 chunks
**Universal games do not support Dynamic terrain


*The '''game template''' (actual game file) is created → new *.ygt file will appear.
== Publishing to workshop ==
*The '''game is optimized''' and "support data" are created → new *.ysd file will appear.
*When workshop export is used, a single *.yca file is generated. This file can be then uploaded to ylands workshop (https://workshop.ylands.com)
**If "Dynamic terrain" option is disabled in "Game settings", static terrain will get compiled and stored as "support data" which increases game performance rapidly.
*It is possible to label the game as '''protected'''
**This process can take a while, depending on size of static terrain.
**Protected games cannot be downloaded from Workshop by other users, played locally or copied
**Games containing custom monetization are automatically protected
**Unprotected games can be downloaded from workshop and played locally, their files can be freely copied


===Local export===
=== Important note ===
*Game template and support data are generated (*.ysd + *.ygt).
*The author of *.yca file and user logged onto Workshop has to be same person -> meaning that their game account and workshop account has to be linked
*Show in folder button can be used to view "local files".


===Workshop export===
== Local export (advanced user only) ==
*Game template and support data are generated (*.ysd + *.ygt).
*It is possible to use '''/exportlocal''' command via console (chat - press enter)
*Both files are packed in to one *.yca file which can be uploaded to Workshop.
*When local export is used, two files are generated
*Show in folder button can be used to view "workshop files".
**The '''game template''' (actual game file) is created → new *.ygt file will appear.
**The '''game is optimized''' and "support data" are created → new *.ysd file will appear.
***If "Dynamic terrain" option is disabled in "Game settings", static terrain will get compiled and stored as "support data" which increases game performance rapidly.
***This process can take a while, depending on size of static terrain.
*Local files can be found in your Steam user profile: <Steam>\userdata\<yourid>\298610\remote\Games
*Local games can be played trough the Main menu → All games → My local games
 
= See also =
*[[Ylands:Monetization description|Monetization]]




----
----
{{Ylands scripting navbox}}
{{Navbox/Ylands}}
{{DEFAULTSORT:{{#sub:{{PAGENAME}}|7}}}}
 
[[Category: Editor: How To]]

Latest revision as of 16:35, 16 November 2022

Overview

In order to publish and play Genesys projects (games made in Editor), they have to be exported from Editor and uploaded to Workshop. Workshop is the primary way how to distribute custom games, both single player and multiplayer, among other players. Its is also possible to export and play games locally, but this is primary intended for testing purposes.

To export a game see Export Game in editor menu

  • Workshop export → optimize the game and create workshop version of Genesys project
  • Optimise → it is also possible to optimise the game in advance, so that the export will take less time
  • Show Workshop files → opens folder with exported games

PC vs Universal games

It is possible to determine target platform of a game. This is specified in Game settings / Common settings

  • PC only → when checked, the game could be run without limitations but only on PC
  • Universal → universal games can be run on both PC and mobile devices, but their play areas is limited by maximum terrain size of 3x3x3 chunks
    • Universal games do not support Dynamic terrain

Publishing to workshop

  • When workshop export is used, a single *.yca file is generated. This file can be then uploaded to ylands workshop (https://workshop.ylands.com)
  • It is possible to label the game as protected
    • Protected games cannot be downloaded from Workshop by other users, played locally or copied
    • Games containing custom monetization are automatically protected
    • Unprotected games can be downloaded from workshop and played locally, their files can be freely copied

Important note

  • The author of *.yca file and user logged onto Workshop has to be same person -> meaning that their game account and workshop account has to be linked

Local export (advanced user only)

  • It is possible to use /exportlocal command via console (chat - press enter)
  • When local export is used, two files are generated
    • The game template (actual game file) is created → new *.ygt file will appear.
    • The game is optimized and "support data" are created → new *.ysd file will appear.
      • If "Dynamic terrain" option is disabled in "Game settings", static terrain will get compiled and stored as "support data" which increases game performance rapidly.
      • This process can take a while, depending on size of static terrain.
  • Local files can be found in your Steam user profile: <Steam>\userdata\<yourid>\298610\remote\Games
  • Local games can be played trough the Main menu → All games → My local games

See also


Ylands - Editor
Editor

Animated objects, Custom UI, Entity welding, Game export, Game ID, Monetization, MIDI music, Optimizations, Common Problems, FAQ

Script

Introduction, Conventions, Client script, Text scripting, Custom controls, Custom controller, Storage Data, Game set, Leaderboards, Matchmaking, Map markers

Game logic

AI Behaviour, Ask Player, Controller, Custom Camera, Custom Controls, Custom HUD, Custom Window, Data Set, Dialogue, Entity Label, Entity Storage, Entity Template, Environment, Event Listener, Game Logic Label, Game Logic Storage, Game Logic Template, Global Storage, Group Template, Image Library, Impassable Barrier, Light, Melee Attack Effect, Particle Effect, Particle Template, Path, Play Area, Player Role, Player Team, Position Animator, Post Process, Reference Point, Resource, Rotation Animator, Script Module, Skill, Sound Effect, Spawn Point, Time Trigger, Transaction, Trigger Zone, Voice Chat Channel, Water Volume

Script tiles

Game, Entities, Game Logic, Logic, Loops, Instructions, Number, Vector, Color, String, Array

Misc

WIKI FAQ

Retrieved from "https://community.bistudio.com/wiki?title=Ylands:Game_export&oldid=332356"