Skip to content

README.md

Latest commit

 

History

History
71 lines (54 loc) · 2.07 KB

README.md

File metadata and controls

71 lines (54 loc) · 2.07 KB

Raycoon Logo
Raycoon Text


A minimal raycasting engine written in Rust.



Raycoon is a small, modern, and educational 2.5D raycasting engine inspired by classic FPS techniques. It focuses on clarity, simplicity, and clean architecture: the core provides pure logic (raycasting, collisions, tile mapping), while rendering and input are handled externally.

Note

  • Developed in personal free time.
  • Educational side project.
  • Contributions welcome.

✨ Features

  • Minimal DDA-based raycasting engine
  • Tile-based world with configurable blocking tiles
  • Per-axis collision handling
  • Strict separation between engine and renderer
  • Simple C-compatible FFI API for easy bindings
  • Lightweight, hackable, and easy to understand

🧩 Engine Language Support

Raycoon’s core is written in Rust, with an official FFI binding available.

Language Support Details
Rust ✔️ Native engine implementation
C ⚠️ FFI-compatible (no official binding)

📦 Installation

Add the crate to your project :

[dependencies]
raycoon = "x.x.x"

⚒️ Example

Run the bundled example :

cargo run --example basic

🤝 Contributing

Contributions are welcome!
Please keep the engine strictly backend-agnostic.
Rendering, input handling, and tooling must remain in external modules.

📜 License

MIT License.