Skip to content

About

A 2D Game Engine built with C++ and Simple And Fast Multimedia Library (SFML)

Resources

Stars

0 stars

Watchers

1 watching

Forks

Repository files navigation

Main Page


Logo

PixelMiner

A 2D Game Engine built with C++ and Simple And Fast Multimedia Library (SFML)
Explore the docs »

View Demo • Report Bug

Table of Contents
  1. About The Project
  2. Configurating and running
  3. Contributing
  4. License
  5. Contact
  6. Acknowledgments

About The Project

PixelMiner is a 2D open world top-down game that allows the player to explore unique and procedurally generated worlds, with multiple options to explore. The project also allows a multiplayer LAN game to share the experience with friends.

(back to top)

Built With

This project was built with:

  • C++
  • SFML
  • minizip-ng

(back to top)

Configurating and running

This project has shell scripts to help building the project. It is recommended to use a Debian-based distro to run this project, although it is possible to build and use in Windows.

This manual covers only Debian-based GNU/Linux distros.

Prerequisites

Install these dependencies in your machine.

Running the project

  1. Install all needed dependencies by running the ./dependencies.sh script (works with APT only, if you have a different distro, install these dependencies manually).
  2. Run ./debug.sh or the ./release.sh script, if you want either the Debug or the Release mode build.
  3. Wait for the external libraries and game sources to build. It may take a while.
  4. When the code is built, the shell script will automatically run the executable.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Top contributors:

contrib.rocks image

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Renan Andrade - Instagram - renandasilvaoliveiraandrade@gmail.com

(back to top)

Acknowledgments

(back to top)

About

A 2D Game Engine built with C++ and Simple And Fast Multimedia Library (SFML)

Resources

Stars

0 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages