57 lines
2.6 KiB
TOML
57 lines
2.6 KiB
TOML
|
[credits] # Optional but highly recommended.
|
||
|
|
author = "who made the manifest for the game"
|
||
|
|
year = "when it was made"
|
||
|
|
license = "license for this manifest"
|
||
|
|
|
||
|
|
|
||
|
|
[scenario] # Required.
|
||
|
|
start = "id" # room where the player starts. any valid room id.
|
||
|
|
title = "title of the game"
|
||
|
|
intro = "intro to the game"
|
||
|
|
prompt = "> " # optional, default shown.
|
||
|
|
playtested = false # optional, default. displays a warning if this is set to false.
|
||
|
|
|
||
|
|
[scenario.win] # Required.
|
||
|
|
trigger = "item" # one of "item", "room" ("interactable" in future releases).
|
||
|
|
target = "id of the trigger" # which item, room (or interactable) should trigger the win.
|
||
|
|
message = "message when the win is triggered"
|
||
|
|
end = false # optional, default; exit the game after triggering?
|
||
|
|
|
||
|
|
|
||
|
|
[items] # Required.
|
||
|
|
item.examine = "message when the `item` is examined" # `item` can be any item id.
|
||
|
|
item.hidden = false # optional, default.
|
||
|
|
|
||
|
|
|
||
|
|
[rooms.id] # Required, id can be any other room id.
|
||
|
|
description = "description of the room as it appears in the listing of exits from other rooms"
|
||
|
|
examine = "description of the room when you examine it"
|
||
|
|
go = "message when you `go` to this room"
|
||
|
|
|
||
|
|
[rooms.id.items] # Optional.
|
||
|
|
item = "description" # item can be any valid id. description is a short description as it appears in the room listing.
|
||
|
|
|
||
|
|
[rooms.id.interactables.id] # Optional. Any valid id.
|
||
|
|
name = "name of the interactable" # appears in the room listing.
|
||
|
|
type = "bare" # optional, default; options: "bare".
|
||
|
|
times = "one" # optional, default; options: "one", "change", "remove", "many".
|
||
|
|
hidden = false # optional, default.
|
||
|
|
action = "add exit" # any of "add exit", "add exits", "add item", "add items", "reveal interactable".
|
||
|
|
target_room = "id" # any valid room id; changes will be made to that room.
|
||
|
|
target_exit.name = "id" # Required if action is "add exit"; name of the exit as it appears in the room listing & id of the room it points to.
|
||
|
|
# Required if action is "add items"; pick one of the following two:
|
||
|
|
target_exits = [ # list of inline tables.
|
||
|
|
{name = "id"}, # similar to a regular exit decl.
|
||
|
|
]
|
||
|
|
target_exits.name = "id" # another way to do that.
|
||
|
|
target_item = {"id" = "description"} # Required if action is "add item"; any valid item id & short description as it appears in the room listing.
|
||
|
|
# Required if action is "add items"; pick one of the following two:
|
||
|
|
target_items = [ # list of inline tables.
|
||
|
|
{id = "description"}, # similar to a regular item decl.
|
||
|
|
]
|
||
|
|
target_items.id = "description" # another way to do that.
|
||
|
|
|
||
|
|
message = "message after the interactable is activated" # Required.
|
||
|
|
|
||
|
|
[rooms.id.exits] # Technically optional.
|
||
|
|
direction = "id" # direction as it appears in the listing.
|