jlechem / textadventure Goto Github PK

A text adventure API framework

C 1.11% C++ 90.87% C# 8.02%

adventure game text text-adventure adventure-game xml antlr4 antlr4-grammar c-plus-plus-14 c-plus-plus

textadventure's Introduction

TextAdventure

TextAdventure is a text based adventure API written in C++ 14 and XML. Image the days of playing Caverns of Mystery, Zork I, III, and III, and many other classic text adventures. I refuse to call them interactive fiction, that's just a dirty word. Now the great thing is you don't need to know how to code in C++ to make games. You will however need to be able to read and create XML files. With the right XML configuatation you could create any kind of game you like. Future releases will have a utility for making the actual XML file so there will be no need for hand crafting adventures.

The API is in a very basic state right now. Players can move around, interact with the enviornment and do most basic commands. However more complex commands still need to be implemented. Work right now is going to be focused on the tools for a while so that more interesting games can be created with less effort than hand crafting XML configuration files. I imagine many different kinds of games being written using the underlying parsing and game engine. Right now it's tightly tied to the current config.xml file which can be modified to have whatever kind of game you want. What should happen is a player can choose which game they want to play with some kind of GUI launcher and then run the actual adventure. I imagine a very hopefully vibrant development community for this kind of thing. So if you're a developer or text adventure afficionado take a look at this and put some work into it if you want. I am looking for active contributors to this project.

textadventure's People

Contributors

Stargazers

Watchers

textadventure's Issues

Implement Visual Game Manager

I need a game manager of some kind to manage actually running the text adventures. You could run them from the command line but why make it harder than it needs to be.

Implement Wield Command

There needs to be a wield command to allow players to wield a weapon.

Update game to accept XML via parameter

Implement Save Command

The same command is sort of done. However other commands like put/open could change an items object state and this needs to be taken into account.

Save has now been re-worked and is saving in the following format (in binary, so no manual editing of save files, at least easily).

The first line is the room id of the player and their score and their items.

RoomID Score ItemID (O|C|X for open,closed,NA)

If an item has sub items then it is followed by :ItemID (O|C|X) | where the number of items repeats until the pipe is found

Each room with an item then repeats in the above format

Implement Combat

Combat needs to be implemented, ie player vs NPC etc.

Implement Visual XML Editor

We should have a visual XML editor that allows users to create XML files graphically instead of hand coding them. This would allow for creation of rooms, items, npcs, etc. The final output would be the config.xml file. This might need to be one of the last items done since changes to the XML file will result in code changes here.

Implement NPCs

Non player characters need to be implemented. The classes are in place but need to be fleshed out.

Implement ANTLR parser and grammar into code

Once the ANTLR grammar is done it and the parser need to get implemented into the project so user input can be validated.

Implement Item sizing

Right now if an item can contain other items we just allow it. We need a size check so that you can't put something large in something small. Also right now it's just a straight one to one capacity. Each item should have a size of some kind, i.e. a sword has a width and length and takes up X total space. A bag can hold up to X total space.