From 3fe834e726b334da042ca7960669f6dd04032010 Mon Sep 17 00:00:00 2001 From: Zeno Rogue Date: Mon, 7 Mar 2022 13:25:19 +0100 Subject: [PATCH] README now explains what RogueViz is --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0906a856..feb82c90 100644 --- a/README.md +++ b/README.md @@ -48,8 +48,12 @@ You can aim for the Orb of Yendor, or you can simply aim for as high score as po ## Modifications OK, now lots of the above can be changed. You can change the geometry and topology (to Euclidean, spherical, or even to nonisotropic 3D geometries). You can play challenges based on -various in-game quests, and even try some other game genres in non-Euclidean spaces (roguelite aka shmup, racing, peaceful puzzles). Or use the engine for non-Euclidean computations -and visualizations (see [RogueViz](http://roguetemple.com/z/hyper/rogueviz.php)). Have fun! +various in-game quests, and even try some other game genres in non-Euclidean spaces (roguelite aka shmup, racing, peaceful puzzles). + +## RogueViz + +HyperRogue uses [RogueViz](http://roguetemple.com/z/hyper/rogueviz.php), which is our engine for non-Euclidean games, computations and visualizations. This repo includes the source code of RogueViz demos in subdirectory `rogueviz`, but +not the data, which is available on [itch.io](https://zenorogue.itch.io/rogueviz). RogueViz is funded by the National Science Centre, Poland, grant UMO-2019/35/B/ST6/04456. ## Development ## @@ -74,6 +78,7 @@ make The `mymake` program builds HyperRogue in parts. It takes longer than the method shown above, but it uses significantly less memory during compilation, and when you change something, `mymake` will only recompile the changed file. Additionally, it can be easily configured, e.g., to produce an optimized build, or to include addons (see `mymake.cpp` for some example invocations, and `devmods` for some example addons). +Most useful parameters include `-O3` (optimized build), `-rv` (include the RogueViz demos), `-vr` (build the VR version). ``` make mymake && ./mymake