diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..cba200b --- /dev/null +++ b/LICENSE @@ -0,0 +1,9 @@ +MIT License + +Copyright (c) 2021 Codinget + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..32b539a --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# rmarcher +A ray marching renderer in rust + +![small example](prod/small.png) + +## Dependencies +- `rust >= 1.51` for const generics +- `crossbeam` && `crossbeam-channel` for multithreading +- `rand` for rng +- `image` for png export +- `rlua` for lua scene building + +## What currently works +- Simple shapes (half-spaces and spheres are the only tested ones so far) +- Spectral simulation (currently using 4 color components) +- Global illumination (with diffuse and reflective surfaces) +- Punctual illumination + +## What is planned +- Testing of more shapes +- Support for a lua-based scene representation DSL +- Support for linking against a `scene.so` exporting a scene +- Support for using as a library + +## Examples +![1st test scene](prod/1.png) + +## License +MIT \ No newline at end of file diff --git a/prod/1.png b/prod/1.png new file mode 100644 index 0000000..1bc0940 Binary files /dev/null and b/prod/1.png differ diff --git a/prod/small.png b/prod/small.png new file mode 100644 index 0000000..92fa9d5 Binary files /dev/null and b/prod/small.png differ