Giter VIP home page Giter VIP logo

text-quest's Introduction

Text Quest: Unlock your imagination

Visit the textquest.io website or play one of the games:

 _             _                          _
| |_ _____   _| |_   __ _ _   _  ___  ___| |_
| __/ _ \ \/ / __|  / _` | | | |/ _ \/ __| __|
| ||  __/>  <| |_  | (_| | |_| |  __/\__ \ |_
 \__\___/_/\_\\__|  \__, |\__,_|\___||___/\__|
                       |_|

                       Unlock your imagination.

Overview

Text Quest is a game engine for running text-based adventure games, using a low/no code approach to game design.

A hosted version of the demo game The Sleepy Traveller (v1.1) can be found at: textquest.io.

Motivation

The project was started to...

  • Inspire creative story writing (without images, CGI or video)
  • Create a low/no code solution for building games (using YAML)
  • Bootstrap something as quickly as possible to test the above (and not get bogged down with tooling, libraries and frameworks)
  • Provide a little escapism during these unusual times

Game Design

Games are defined using YAML. A sample game can be seen in ./game.yml).

Here's an overview of the core concepts within a games:

  • Blocks: A block represents a single location within the game. A block can have:
    • exits: Connections to other blocks
    • states: Variations for a block state (containing exits, actions, items)
    • items: Items which are 'visible' from within a block state
    • actions: Actions which can be performed by the player within a block state, and actions which can be triggered automatically based on what a player is carrying
  • Game: The name, version and author for the game
  • Player: The name, current block location, powers and items they are carrying
  • Powers: Descriptions for powers a player can unlock (not listed here, as they are part of the game)
  • Items: Descriptions for items which the player can carry, or can be found in a block

Technical Details

This project currently uses:

  1. JavaScript as the core programming language for the game engine
  2. Parcel web application bundler
  3. text-terminal for the terminal interface
  4. YAML to store the game configuration
  5. js-yaml for YAML > JSON conversion
  6. ascii generator for the logo
  7. github-fork-ribbon-css

Development: Getting Started

  1. Run npm i: To install the dependencies
  2. Run npm start and open localhost:1234 in a browser to view the live reload development server
  3. Changes in the ./src directories will cause a live reload and compiled files to ./dist
  4. Press CTRL+c to stop the development server

TODO

  1. Introduce characters as a concept (and associated powers)
  2. Cross over with voice activation project
  3. Upload/point to yaml URL
    1. Auto conversion yaml > JSON
    2. Game yaml validator
  4. Create a supporting website with docs and links to games
  5. Online game editor (visual, or text based)

text-quest's People

Contributors

desholmes avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.