Skip to content

janthmueller/2D-Raycasting

Repository files navigation

Contributors Forks Stargazers Issues MIT License


2D-Raycasting

Simple 2D-Raycasting simulation with pygame.
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Draw lines or boundaries and move a light source to observe the rays.

Product Name Screen Shot

Built With

Major frameworks/libraries used to bootstrap the project.

(back to top)

Getting Started

Prerequisites

See requirements.txt for more information.

Installation

Usage

Mouse:

  • Left mouse button:
    Draw lines/boundaries
  • Right mouse button:
    Set/move light source
  • Mouse wheel:
    Increase/decrease number of rays

Keys:

  • Key b:
    Add/Remove invisible lines/boundaries at the edge of the window
  • Key h: Hide/reveal the drawn lines
  • Key z: Delete last drawn line

Roadmap

  • Class for ray
  • Decouple ray intersection algorithm from draw method (still quite dirty)
  • Improve ray intersection algorithm
  • Add argparser

See the open issues for a full list of proposed features (and known issues).

(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

(back to top)

License

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

(back to top)

Contact

Jan Thomas Müller

Project Link: https://github.com/janthmueller/2D-Raycasting

(back to top)

Acknowledgments

(back to top)

About

Simple 2D-Raycasting simulation with pygame.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages