Skip to content

jossse69/roguelike_project

Repository files navigation

⚔ roguelike project ⚔

This is a hobby project aimed at creating a roguelike game using Rust programming language and the bracket-lib library. Please note that this project is currently a work in progress and is incomplete.

About

This project is an attempt to create a classic roguelike game using Rust and the bracket-lib library. The goal is to implement features such as player movement, entity interactions, procedural map generation, and more.

Project Status

As of now, the project is in its early stages of development. Basic functionality, such as player movement and rendering entities, has been implemented. However, there is still much work to be done to create a fully featured roguelike experience.

Getting Started

To run the game locally, you'll need Rust and Cargo installed on your machine. Clone the repository and use the following commands:

git clone https://github.com/jossse69/roguelike_project.git
cd roguelike_project
cargo run

Controls

use mumberpad to move
press E to open the inventory
press I to inspect an item in your inventory
press ESC to exit (a pop-up or just close the game)
more controls to come

Contributing

Contributions to this project are welcome! If you're interested in helping out, feel free to open issues or pull requests. Since this is a hobby project, development might be sporadic, but any help is appreciated.

License

This project is licensed under the MIT License.

Acknowledgements

The game is built using the bracket-lib library. Check it out here.
Special thanks to the r/roguelikedev community for support and inspiration.
also thanks to GPT3.5/chatGPT by openAI for writing this readme.
Please keep in mind that this project is a hobby endeavor and is not intended for commercial use. Enjoy the journey of game development!