Skip to content

The Gamedoc

The Gamedoc says what a Project’s game is to be, in words. It has four parts: Description, Questions, Design, and Sound. Every Member of the Project reads and writes it. The Agent reads it before it builds, and changes it where what it built changes what the Gamedoc says.

A Project made from a Plan starts with a copy of the Plan’s description, its answers, its Design and its Sound as its Gamedoc, written as below. The picture of the Direction picked there stands over the Design part. Any other Project starts with the four parts empty.

Each part is a Markdown file of the Project, gamedoc/description.md and so on, with a blank line around each heading. A part the Plan says nothing in is not written.

  • Description: the Plan’s description, as you wrote it.
  • Questions: ## Asked of every game and ## Asked about this one, each a table with a row a line, | Question | Answer |. A skipped question is left out, and so is one with no answer. A | in an answer is written \|.
  • Design: the picked Direction’s picture first, as the line ![Park day](design.svg). Then ## Direction, ## The look, ## Style, ## Colours, a colour a line such as - Sky #8fd3ff, and ## Pictures, the names of the pictures to go by.
  • Sound: ## Direction; ## How it should feel, a table of Mood, Instruments and Tempo; ## The moments, a table | Moment | Sound |; and ## Tracks.

The Agent reads and changes these as Markdown. A Run that changes one answer changes that row’s line, and the rest of the table stays as it was.

The Gamedoc panel is in the middle of the editor, beside Scene and Game, and Code while a script is open. Under its name are four tabs, one for each part. One part shows at a time, and the panel opens on Description.

A part reads as a document. Its headings are larger, its tables are drawn as tables, a colour line has a swatch of its colour, and on Design the Direction’s picture shows where its line puts it. A link is not followed, and no other picture is loaded.

Click in the text and write. There is no Edit button and no Save.

  • Only what you write in shows its Markdown: the paragraph, heading or list item, or the whole table, that the caret is in. The rest stays as it reads. Down and Up go into a table or the picture as into any line.
  • Markdown, above the part, shows all of it as Markdown, and As it reads goes back.
  • In this part, beside the text, lists the part’s headings. Press one to go to it.
  • What you write is kept about a second after your last key, and at once when you put another panel in front or leave the page. Until then the part’s tab has a dot.
  • A part holds 48,000 characters. When one is full the panel says so, and what is written or pasted beyond that is not taken.
  • An empty part says Nothing here yet. Write, or ask the Agent to.

A change you make reaches every Member who has the Project open, about a second after you stop writing. Their page takes it with no reload, and their caret and their place in the text stay where they were.

If someone else changes a part while you have text in it that is not kept yet, your text is not written over, and theirs is not either. The panel says Someone else changed this part, shows the part as they left it, and you choose:

  • Take theirs shows the part as they left it. What you wrote here since is gone.
  • Keep mine keeps what is on your page, the whole part. What they wrote is written over, on their page too.

Nothing of yours in that part is kept until you choose, also if your page loads anew in between.

Two Members who write in different parts never meet this way.

The Agent reads the Gamedoc before it builds. A Project made from a Plan is first asked to build the first playable version as the Gamedoc describes it.

Where a Direction was picked in the Plan, the Agent sees its picture too, and builds the game in its colours and its style. Before it answers, it plays the game, takes a picture of it, compares that with the Direction, and fixes the largest difference it sees, once. It says in the Agent panel what it compared and what it changed.

The Agent keeps the Gamedoc true to the game. When a Run changes what the Gamedoc says of the game, the Agent changes that part, line by line, and says in the Agent panel which parts it changed.

What the last Run changed is marked where it stands, in the text you write in:

  • The lines it wrote are tinted. Under them is Stood here before: and what stood there, or Added by the Run. Where it took lines out, Taken out by the Run: says what they were.
  • The tab of each part it changed says Changed by the Run.
  • Over the part, a sentence names the parts: The last Run changed Sound: marked in the text, with what stood there before.

A mark stays while the line stands as the Run wrote it: write on a line and its mark goes. When the next Run starts, the marks of the Run before go, and what the new Run changes is marked instead.

You can write in the Gamedoc while a Run works. The Run’s change is made line by line, against the Gamedoc as it read it:

  • Where nobody changed those lines meanwhile, the Run’s change goes in, marked.
  • Where a Member changed the same lines meanwhile, what the Member wrote stands. The Run’s change waits under it, in a box that says The Run wrote the text below for this place, with Take the Run’s and Keep what stands. Any Member can choose.
  • The part’s tab says 1 waits, the sentence over the part says so, and the Agent says so in its panel.

Take the Run’s puts the Run’s text in, marked, with what stood there before. Keep what stands lets it go. A change that waits stays until someone chooses, also after the next Run. If the lines it waits under change again, it waits under what stands there then.

If you are writing in that part at the moment the Run’s change arrives, it goes into your text above and below where you write, and your caret stays where it is. Where you were writing, yours stands and the Run’s waits.

Sometimes the panel cannot tell your change and the Run’s apart, line by line:

  • you or the Run changed several hundred lines at once;
  • the Run’s change could not be noted to wait under yours, or your page loaded anew before it was.

The panel then says The Run changed this part and shows the part as the Run left it. You choose with Take the Run’s or Keep mine, as when another Member changed it.

Nothing either of you wrote is lost: a Member’s change is never written over by a Run, and a Run’s change is never dropped without a word.

Each part is a text file in the Project: gamedoc/description.md, gamedoc/questions.md, gamedoc/design.md, and gamedoc/sound.md. A part with nothing in it has no file. Beside them, gamedoc/marks.json holds what the last Run changed and what of a Run waits.

The files are part of every Checkpoint.