Skip to content

Latest commit

 

History

History
executable file
·
122 lines (92 loc) · 4.78 KB

readme.md

File metadata and controls

executable file
·
122 lines (92 loc) · 4.78 KB
Raw

Hey, maybe you wanted to have the source of the modified game Terminus.
Sadly, this is the wrong page, now check the original branch.

Terminal game common

A tool box to create games with command line interface, based on a classical filesystem structure.

What does provide this (game) engine ?

  • a customizable terminal (command line) interface
    • for Web browser (Javascript)
    • from a shell (experimental - Python)
  • most of a shell functionnalities
  • picture and music support
  • some game dev tools : build, manage resources, track credits, split/group translations

Games

A rewrite of mprat's Terminus game (code)

Terminus is a text adventure game running on your Web browser.

In a mysterious land, both physical and magical powers had been surpassed by a new power : the command line. Lost somewhere in this land, you discover that you could use this power without knowing how.

Jouer (French) : Démo du jeu

Note : If you tested the original Terminus game, you may discover that : the scenario had been altered; the MIT part and the 'add' locker command had been removed, because these things are really specific to MIT; there is sounds...

Why ?

Originally, the project was intended to translate the game "Terminus" from English to French. Now, this framework is an attempt to be a kind of command line based "Twine" with files and programs as items for the player.

Dialogs outside of code

Dialogs and relation between object was written in code. This was an obstacle for translation contributors.

Here, the file structure and dialogs has been put outside of code. The dialogs are referenced with a keyword like (e.g. room_home_text). Translations can be found in each directory, but can be all gathered in one po file.

No Interactive Fiction maker that could easily describe files permissions and commands was found

The needs :

  • textual player input that provide completion
  • the world as filesystem
  • all items (that include game items and characters) described with dynamic properties
  • an item can have specific behavior with any command
  • the programs (commands that are not a shell function) are items
  • The player shall be able create/read/copy/move/rename/delete items and use commands on them

Here, each item have a text description and additional properties (including the program associated to the file). If it is a quest item, the properties can be filled when it appears in the right place.

This framework just reproduce the behavior of a shell. Why not just sandboxing some rootfs ?

Yes, it could do the job. You can even add sound, images and event with a small bunch of code that the source a profile on each directory. (look at tiv for images, and aplay for sounds)

But sometimes, you need to add some restrictions, and extra features to make a game interesting.

Start game

Build

  • ensure you have all resources in./game_art : make fetch_resources
  • assemble the game(s) in ./game
    • use make build to build for all Browsers/Platform
    • use make assemble if for some reason you want to build while skipping Nodejs (and npm) part

Start game

make server, select the game and go to the url given as response.

Why the terminal ?

Our usage of computers are focused on graphical user interfaces. By ignoring command line, you miss a huge collection of usefull tool you can use to automate your task.

Some examples of things you can easily do with command line :

  • find files or a specific informations
  • change a word for each file of a collection of thousand
  • convert your whole multimedia library in any format
  • insert text (or copyrights) in images and videos
  • press a key every 2 seconds, without touching your keyboard
  • install applications from source
  • use advanced options
  • access servers
  • develop scripts to repeat useful tasks

Helping

Things in thinking/doing are located in TODO file. Feel free to check it, raise issues and push PR if you got something.

Tips for game makers

Language

Edit .po files in game directory to edit translation. In tools/gamedev, there is tools to generate the .pot file, and ensure all references are translated.

Note for game dev

  • ./game/terminus/devenv.sh set up a bash shell for dev...
  • to work on develop branch : git fetch origin; git checkout --track origin/develop
  • get missing tools git submodule update --init --recursive