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!
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.
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!
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.