jlvaquero / scunm

Text Adventure Engine, Editor and Telegram Bot host

SCUNM

Second prize winner in Spaghetti Code Fest at ETSIS University

This is Script Creation Utility for Nodejs Maniacs; a text adventure game engine and Telegram bot as host, writen in node.js. The engine aims to be easily consumed by a Telegram ChatBot through standarized output that allows text, images (even animated gifs) and interactive selection although, thanks to the low coupling design, different hosts and UI are possible.

Instead of free text input, the UI will show custom keyboard for verbs and inline buttons for interactive things that the user will use to send commands to the game engine.

The engine keeps in memory shared game assets for all players and allows the host to load and unload the game state for each player on request. This is perfect for host the engine on server and use it through stateless protocols (i.e. HTTP ) in a multiuser enviroment.

Game assets are defined using plain javascript object initializer with embedded game custom scrips and images will be URL references from any host (your host site, google drive, dropbox, ms onedrive, etc should work).

Keep in mind that the priority is to easy the content creation for game designers; so a lot of concessions was made (read: technical debt and low resilence) to reach to a minimum viable product in its current state.

Game editor has just been born. Electron-React-Redux makes things easy ;)

It is in Alpha state. You can fork it and pull request.

Runing in your machine

Create your bot with https://t.me/BotFather.

Change "var botTokenAuth = "399277036:AAHmfEFe3LcfDkvejKaz_RPxcNHhkQRvf2E"" in Application\app.js with the token botfather provides you.

Visual Studio 2017: Open SCUNM.sln in VS. Restore Nuget packages for Redis. Restore NPM dependecies. Run Application\start.bat.

Other: Restore NPM dependecies. Run redis server. Modify Application\app.js with redis connection config. Run "npm start".

You should be able to play Demo in your bot like in this video:

scunm's Issues

ToDo: Dynamic verbs

Engine should allows change/restore verbs in "real time".

Use rejson module to save just the changing data instead the whole state object.

Use rejson module to save just the changing data instead the whole state object.

Clustering

Make changes needed for clustering on multicore systems.

ToDo: Telegram bot configuration.

Options to configure the telegram bot (pollin or webhook)

ToDo: Error Handling

Implement error handling in the whole code base.

ToDo: Game library.

Make a game library. Let user select the game to play from the library.

ToDo: Instrumentation, tracing and loging.

Implement loging and tracing.

Make engine stateless,

Pass state to every command ejecuted by the engine and make the engine return the state as response to avoid race conditions when await to get data from redis.

ToDo: WebServer host and web client.

Make HTML/CSS/clientside javascript/serverside host to allow play in a web page.

ToDo: Test.

Implement unit, integration and system test.