Skip to main content
Where a game is made: list, create, build and open projects. 10 operations. How to call them, and what the answers mean: Operations reference.
Generated from the summer-engine npm package 4.8.0: its public operation catalog (registry/operations/public-catalog.json) and its engine and local operations. If something here is wrong, the operation’s definition is wrong.

build

projects.build: Build a game from a plan Build a playable game in the cloud from a plan’s saved direction, as Build in Studio does. Spends the plan payer’s credits. The same direction returns the same build unless you send a new idempotencyKey. Returns a job. Next: jobs.wait. Inputs:
Example: Build the saved direction.

builds

projects.builds: List a plan’s builds The recent cloud builds of a plan, newest first, with their job ids and states, and whether cloud builds can start right now. Next: jobs.get with a build’s jobId. Inputs:
Example: Did the last build work?

create

projects.create: Start a new game Start a new game from the person’s idea: Summer creates the project and its plan and starts drawing the plan’s first pictures at once. One sentence is enough. Returns the projectId. Next: plans.show or plans.message. Inputs:
Example: Start a game from one sentence.

create_local

projects.create_local: Create a project on this computer Create a project on this computer. Writes a template (3d-basic by default) to a folder, no shell needed. Returns projectPath. Next: projects.open_local. Inputs:
Example: Create a project on this computer

get

projects.get: Read a project Read one Summer project: name, kind, share state, where it opens, its game plan (planId for plans.get) and the idea it was made from. Next: plans.get with the planId. Inputs:
Example: Open the plan behind a project.

list

projects.list: List my projects List the person’s Summer projects, newest edit first: project id, name, kind (browser, cloud or desktop), share state and where it opens. A project is not a store game (games.list). Next: projects.get. Inputs:
Example: What has this person been making?

open_in_engine

projects.open_in_engine: Build a new game in Summer Engine Hand a game started with projects.create to Summer Engine on the person’s computer: the download for Mac and Windows, the setup steps and the saved direction to build from. Nothing is built in the cloud. Next: follow the steps with the person. Inputs:
Example: The person is happy with the plan; build it for real.

open_local

projects.open_local: Open a project in Summer Engine Open a project in Summer Engine. Waits until it connects; installs the engine only with install: true (the person’s yes). Next: engine.get_project_context. Inputs:
Example: Open a project in Summer Engine

preview_build

projects.preview_build: Play a cloud build A link that plays a finished cloud build of a plan in the browser, as Play in Studio does. The link works for about two minutes: give it to the person at once. Next: projects.builds. Inputs:
Example: Let the person play the build.

rename

projects.rename: Rename a new game Rename a game started on the create page or with projects.create: its project, its plan and the concept kept for Summer Engine take the new name. Next: plans.show. Inputs:
Example: A better name.