Adventure metadata - rmed/textventures GitHub Wiki

The adventure XML information files contain basic information regarding the story. This file must be named metadventure.xml in order to be able to parse it.

Sample code

<textventure>
  <!-- Title of the story -->
    <title>The TextVentures Adventure</title>
    <!-- Description of the story -->
    <description>Sample textventures story</description>
    <!-- Author of the story -->
    <author>RMed</author>
    <!-- Email of the author (optional) -->
    <email></email>
    <!-- Story/Support URL (optional) -->
    <url>http://github.com/RMed/textventures</url>
    <!-- Version of the story -->
    <version>1.0.0</version>
    <!-- Compatible version of TextVentures -->
    <compatible>0.2</compatible>
    <!-- First scenario -->
    <first>initial</first>
    <!-- Available locales -->
    <locale>
        <lang>en</lang>
        <lang>es</lang>
    </locale>
</textventure>

Markup details

title

Title of the adventure.

description

Short description of the adventure.

author

Name of the creator of the adventure.

email

Optional. Contact email of the author.

url

Optional. Support URL or author's website.

version

Version of the adventure.

compatible

The version of TextVentures in which this adventure will load. If this version and the version of the program do not match, the game will not load. The adventure maker should update the adventure accordingly.

The tag can contain only the major an minor version numbers of TextVentures, as these are the numbers that could change when an update to the adventure system is made.

Therefore, if we wanted to run an adventure for TextVentures version 1.2.3, then the compatible tag should be 1.2 in order to run in minor revisions (i.e. 1.2.4) as well.

first

First scenario of the adventure.

locale

Available languages in which the player can play the adventure. Each lang tag represents a subdirectory of the adventure that contains the specified localized version (in the example there would be two directories "en" and "es", each with their translated adventure version).

⚠️ **GitHub.com Fallback** ⚠️