slappedwithsilence / txengine

TXEngine is a modular and configurable text-based game engine. Write entire text-based games without writing a single line of code!

TXEngine

TXEngine is a text-based game engine written in Java. The goal of this project is to create a rich toolset of game elements that empower designers to build flexible and unique worlds. With TXEngine, designers create games entirely by manipulating a set of JSON files--no code needed. TXEngine also features a rich content designer that can assist users of the engine with writing, tracking, and checking their JSON game components (coming soon).

Looking for usage documentation? Visit the wiki!

Technologies

TXEngine is designed to be as portable and lightweight as possible. As such, it does not use any heavy frameworks or engines. TXEngine is built in Java and use Maven for dependency management.

Developing TXEngine

Getting TXEngine set up on your machine is simple. Install Maven (3.8+) and JDK 16 for your specific platform (available on Windows, Linux, and OSX) and then run the following commands from the root folder of TXEngine:

mvn compile

mvn exec:java

At this point, TXEngine's default game should have launched in a console window.

It is highly-recommended to develop TXEngine using an IDE with Maven integration such as IntelliJ. Setting up TXEngine in IntelliJ is simple.

• Clone this repository into a folder
• Open the repository as a project in IntelliJ
• Make sure it is recognized as a Maven project
• Create a Run Configuration with the command line field set to mvn:exec.
• Edit the new Run Configuration to 'Build Project' before launch under the 'General' tab

At this point, the project should be set up and ready to run!

To find out more about how TXEngine works, visit the wiki!

Limitations

TXEngine relies on embedded color codes. These codes do not work on CMD in Windows, and as such, can't be run through it (with colors). A solution for launching TXEngine through Powershell is under development. Until then, you can run TXEngine on Windows by using either Cygwin or WSL Ubuntu, or any native Linux distribution.

txengine's Issues

Conversations are one time events

Possibly not a bug and is intended but the debug conversation "Speak with doomsayer" only works once and on subsequent tries is immediately exited with no error.

DispelCombatEffect doesnt work, my solution in comments

DispelCombatEffect never runs through its constructor before engine call so DispelInstanceOf variable is never set

Solution: Just change getDispelInstanceOf to get property[0] instead. No need to run the unique constructor

Add LoadableMixin to InventoryController

Implement LoadableFactory

Implement a factory class that makes available a class method for universally converting JSON objects into python objects via the loader cache.

Implement CurrencyEvent tests

DungeonMove sometimes displays incorrect MenuText inside a Dungeon

Occasionally, a DungeonMove will not correctly display the coordinates that it truly points to. For example, if the DungeonMove points to 0,1 its MenuText may be set to 1,1 or 1,0.

Write tests for EquipmentController

Test equip and unequip and ensure that they do not cross-contaminate, erase items incorrectly, or duplicate items.

Add LoadableMixin to ResourceController

Add LoadableMixin to CoinPurse

Add LoadableMixin to EquipmentController

User should be able to forfeit a dungeon midway

Its possible for a user to get trapped in a dungeon if it is too difficult or they are ill-prepared. As such, the user should be able to forfeit the dungeon at any point.

Dispel Combat Effect does not like to be used to dispel itself

Dispel Combat Effect gives a concurrent modification exception when used to dispel itself