A learning project to create a text-based adventure game. I hope you enjoy playing the game, I had fun creating it.
image of the game intro screen will be here as png
- Adventure Game
- Description
- How to play
- How to run
- How to build
- Documentation
- License
- Contributing
- Code of Conduct
- Acknowledgments
- Authors
This is a text-based adventure game implemented in Java. When ever I am learning a new programming language, I like to implement a text-based adventure game.
It is a fun way to learn the basics of the language. I like to use object-oriented programming to implement the game. But I also like to keep it simple and not over-engineer it.
The game is a text-based adventure game. You play as a human explorer. You are exploring a dungeon with the goal of finding the treasure and then escaping the dungeon. In the dungeon you will encounter monsters and traps that you must overcome.
You will also find items that will help you in your quest. You will need to make choices on which way to go and what to do. I hope you enjoy playing the game. There are no graphics, just text. Use your imagination, there is no hand-holding in this game. You will need to figure out what to do on your own.
To run the game, install one of the pre-built binaries from the releases page. Then run the binary from the command line. The binaries are generated automatically by the CI/CD pipeline that I have set up for this project. the binaries are built for Windows, macOS, and Linux while supporting x86, x64 , arm, and arm64 architectures.
To build the game from source, you will need to have Java installed on your system using the GraalVM JDK . You will also need to have gradle installed. I use IntelliJ IDEA as my IDE, but you can use any IDE that you like.
To build the game:
- Clone the repository
git clone repo-
Open the project in your IDE or use the command line
-
Build the project native image using the gradle task
nativeCompile
gradle nativeCompile- Run the game
./build/native/nativeCompile/AdventureGameThe game is documented using JavaDoc. The code is also commented. You can
find the JavaDoc in the docs folder. I will also be including diagrams.
Brainstorming, flowcharts, and pseudocode that I made while creating the game,
to serve as documentation.
This project is licensed under the MIT License - see the LICENSE file for details.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to me.
Please read CODE_OF_CONDUCT.md for details on our code of conduct.
A great read on text-based adventure games, the history and how they work.
An interesting article on how text-based adventure games can be used to tell stories. I used some of the ideas in this article to create the story for the game.
A great tutorial on how to create a text-based adventure game in Python. It also explains some general programming concepts like flowcharts and pseudocode, modelíng and design, and testing. I used the ideas in this tutorial to create the game.
- Pavel Hrdina - pavel-hrdina