A SDL roguelike in a non-euclidean world.
Go to file
Zeno Rogue 7b3d2c2626
Merge pull request #377 from jlmjlm/prune_tab
Prune table of new land candidates.
2024-05-16 22:04:51 +02:00
.github/workflows disabled simple test 2024-04-28 02:40:43 +02:00
contrib add desktop file 2022-09-14 09:44:01 +02:00
devmods small fixes to gentrans 2023-12-27 16:27:05 +01:00
dll Add cross-compile support 2015-08-22 13:43:16 +02:00
generators removed BUILDZEBRA from drawcell 2019-10-25 09:22:19 +02:00
honeycombs new system for honeycombs in action 2022-08-26 12:27:57 +02:00
hyperroid version 13.0a 2024-01-13 09:03:12 +01:00
music fixed the ogg files 2022-10-27 16:06:39 +02:00
rogueviz color change in rogueviz 2024-05-09 10:44:37 +02:00
sounds license specified for the recorded sounds 2022-09-15 11:24:44 +02:00
tessellations a sample with mirrors and apeirogons 2022-10-07 22:19:10 +02:00
.gitignore Eliminate autotools/automake/configure. 2021-03-21 17:19:41 -04:00
3d-models.cpp pipes for anisotropic geometries 2023-06-10 11:05:57 +02:00
CITATION.cff improved citation metadata 2021-09-15 17:21:56 +02:00
COPYING Initialization with hyperrogue-66 2015-08-08 15:57:52 +02:00
DejaVuSans-Bold.ttf Initialization with hyperrogue-66 2015-08-08 15:57:52 +02:00
Doxyfile Doxygen files added 2019-09-12 23:35:04 +02:00
FUNDING.yml GitHub sponsor added 2019-11-02 15:45:42 +01:00
Makefile Include the GCC compiler's install too. 2024-04-20 15:29:31 -07:00
Makefile.rv French language translation by @3raven 2022-07-01 14:11:14 -04:00
README.md added the Discord link to README 2024-04-28 02:34:39 +02:00
achievement.cpp Removed references to private/daily.cpp and private/hypersteam.cpp. Also removed HAVE_ACHIEVEMENTS as it was redundant to CAP_ACHIEVE 2024-05-16 21:21:13 +02:00
aperiodic-hat.cpp Aperiodic Spectre tiling 2023-05-30 18:44:03 +02:00
arbitrile.cpp redone the canvas coloring system 2024-05-09 10:44:37 +02:00
archimedean.cpp redone the canvas coloring system 2024-05-09 10:44:37 +02:00
asonov.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
attack.cpp new messages on Orb of Phasing, Slaying, and Weakness 2024-03-27 23:52:22 +01:00
barriers.cpp fixed CR3 generated in CR2 layout 2024-05-09 10:44:37 +02:00
basegraph.cpp fixed two-eye rendering in stereo modes which should not cause that 2024-01-07 09:07:54 +01:00
bigstuff.cpp fixed single wrong tile of the first land when safetying in landscape etc 2024-05-09 10:44:37 +02:00
binary-tiling.cpp a new pseudopept pattern in Binary4 and Ternary 2024-04-08 19:14:01 +02:00
blizzard.cpp used cyclefix and raddif in more places; (c)spin90, (c)spin180 and spin180 functions; rephrased M_PI in terms of TAU and x._deg when applicable 2022-11-13 16:22:55 +01:00
cell.cpp fixed a freeze when computing distance in INVERSE 2024-02-22 20:30:35 +01:00
celldrawer.cpp unflipped mine_zero_display 2024-05-10 19:28:47 +02:00
changelog.txt 13.0i 2024-05-10 20:40:54 +02:00
checkmove.cpp edit minefield colors in minefield config 2024-05-10 19:28:26 +02:00
classes.cpp improved in/on messages, also for Brownian III 2024-02-23 01:22:30 +01:00
colors.cpp Change `static const` to `static constexpr` wherever possible 2023-08-23 09:47:28 -08:00
commandline.cpp save/load mode data, via CLI 2024-03-14 19:28:33 +01:00
complex.cpp LB_PRINCESS instead of magic value 36 2024-05-09 10:44:37 +02:00
complex2.cpp added AntiRogue to knight names 2024-03-24 19:28:02 +01:00
config.cpp Make option to show turns on the main screen. 2024-05-16 08:31:45 -07:00
content.cpp stone gargoyles and statues are now non-blocking for missiles 2024-05-09 10:44:37 +02:00
control.cpp reverted numlock on MAC 2024-05-10 19:29:14 +02:00
crossbow.cpp Show weapon watermark with geometric xbow. 2024-04-22 09:26:29 -07:00
crystal.cpp Change `static const` to `static constexpr` wherever possible 2023-08-23 09:47:28 -08:00
debug.cpp save_cheats option, also fixed buffer overflow 2024-03-27 23:52:22 +01:00
dialogs.cpp added some CAP_ guards so Android compiles 2023-12-30 08:10:34 +01:00
direntx.h Add "inline" to silence GCC's -Wunused-function warnings in direntx.h. 2018-06-29 16:26:20 -07:00
drawing.cpp new projection: polar coordinates 2024-02-22 01:16:43 +01:00
earcut.hpp Remove extra semis in struct defs 2021-06-28 22:33:08 -07:00
embeddings.cpp added some CAP_ guards so Android compiles 2023-12-30 08:10:34 +01:00
embuild.sh emscripten uses ZLIB 2020-03-07 04:47:10 +01:00
environment.cpp made bfs in 3D always know nearby cells even if gmatrix not known 2024-05-09 10:44:37 +02:00
euclid.cpp array initializer did not compile on Steam 2023-10-28 10:04:15 +02:00
expansion.cpp mapfontscale setting 2024-03-21 18:44:19 +01:00
fake-mobile.cpp fixed fake-mobile 2024-05-16 21:21:42 +02:00
fake.cpp fixed errors about underlying_map uninitialized 2024-05-16 21:21:14 +02:00
fieldpattern.cpp Change `static const` to `static constexpr` wherever possible 2023-08-23 09:47:28 -08:00
flags.cpp crossbow:: graves and Round Table are non-blocking, thruVine is blocking 2023-10-28 23:33:38 +02:00
floorshapes.cpp nicer plain floorshapes in IRREGULAR maps 2024-03-24 00:29:45 +01:00
game.cpp push an exploding barrel on a mine now causes an explosion 2024-04-07 23:36:06 +02:00
geom-exp.cpp redone the canvas coloring system 2024-05-09 10:44:37 +02:00
geometry.cpp scale now always can be changed, but cheater flag is set in shmup 2024-03-24 00:39:02 +01:00
geometry2.cpp fixed relative_matrix_recursive in some geoms 2023-10-05 13:55:12 +02:00
glhr.cpp Qualify calls to `format` 2023-08-21 10:18:44 -07:00
goldberg.cpp fixed errors about underlying_map uninitialized 2024-05-16 21:21:14 +02:00
graph.cpp Merge pull request #374 from jlmjlm/time2 2024-05-16 20:28:22 +02:00
help.cpp edit minefield colors in minefield config 2024-05-10 19:28:26 +02:00
heptagon.cpp fixed an error computing distances in bitruncated {5,4} causing crashes 2023-02-21 18:47:43 +01:00
history.cpp fixed a crash with too large band 2024-02-22 18:41:52 +01:00
hprint.cpp hstream_exception now can contain explanation 2024-03-23 21:19:04 +01:00
hr-icon.ico Initialization with hyperrogue-66 2015-08-08 15:57:52 +02:00
hud.cpp Show weapon watermark with geometric xbow. 2024-04-22 09:26:29 -07:00
hyper-main.cpp savefile selection / an option to use no savefile 2022-09-15 12:38:39 +02:00
hyper.cpp Removed references to private/daily.cpp and private/hypersteam.cpp. Also removed HAVE_ACHIEVEMENTS as it was redundant to CAP_ACHIEVE 2024-05-16 21:21:13 +02:00
hyper.h 13.0i 2024-05-10 20:40:54 +02:00
hyper.rc 10.0n 2017-09-04 20:43:45 +02:00
hyper_function.h Consistently apply `override` (and not `virtual`) to overriding virtuals 2023-08-21 10:23:48 -07:00
hyperpoint.cpp fixed multiply transmatrix * trans23 2023-08-15 15:20:46 +02:00
hyperrogue-music.txt fixed the new music 2021-06-09 05:49:54 +02:00
hyperweb.cpp hyperweb:: use XLAT1 not XLAT 2023-12-03 14:29:26 +01:00
hypgraph.cpp fixed model orientation for spiral 2024-05-16 21:21:14 +02:00
inforder.cpp Add `explicit` and `override` consistently everywhere else. NFCI. 2021-07-11 18:03:08 -04:00
intra.cpp removed debug from intra 2024-03-14 19:29:36 +01:00
inventory.cpp Change `static const` to `static constexpr` wherever possible 2023-08-23 09:47:28 -08:00
irregular.cpp irregular maps no longer save a different modeline every time due to floating point precision 2024-03-27 23:52:22 +01:00
items.cpp since the Aether users now see adjacent items in water, they can also pick them up 2024-04-09 02:42:25 +02:00
kite.cpp rewritten the embeddings more nicely 2023-01-27 00:27:10 +01:00
landgen.cpp changed the guarding in Power landscape 2024-05-10 18:52:23 +02:00
landlock.cpp Check for having pruned all land candidates. 2024-05-16 12:46:06 -07:00
langen.cpp square root symbol 2023-03-28 14:10:13 +02:00
language-cz.cpp translation update: CZ 13.0 included and some fixes 2023-12-27 10:40:04 +01:00
language-de.cpp clarify Water Elemental special case 2023-10-29 07:58:00 +01:00
language-fr.cpp fixup to honeycomb 2023-12-03 14:48:10 +01:00
language-pl.cpp translation update: CZ 13.0 included and some fixes 2023-12-27 10:40:04 +01:00
language-ptbr.cpp fixed 'Orb of the Love' 2021-12-12 20:41:11 +01:00
language-ru.cpp clarify Water Elemental special case 2023-10-29 07:58:00 +01:00
language-tr.cpp clarify Water Elemental special case 2023-10-29 07:58:00 +01:00
language.cpp Qualify calls to `format` 2023-08-21 10:18:44 -07:00
legacy.cpp customize land mode 2024-03-14 19:27:08 +01:00
locations.cpp fixed a bug causing not compiling in C++20 2024-05-16 21:21:13 +02:00
makeh.cpp one more update for older compilers 2019-09-13 18:33:15 +02:00
mapeditor.cpp fixed CLI -picload 2024-05-09 10:44:37 +02:00
mapeffects.cpp fixed the West Wall being not inaccessible from some lands 2024-04-08 00:58:34 +02:00
menus.cpp redone the canvas coloring system 2024-05-09 10:44:37 +02:00
mingw.condition_variable.h fixed the thread locking 2020-01-28 17:58:55 +01:00
mingw.invoke.h threads in MinGW 2020-01-16 18:11:59 +01:00
mingw.mutex.h threads in MinGW 2020-01-16 18:11:59 +01:00
mingw.shared_mutex.h fixed the thread locking 2020-01-28 17:58:55 +01:00
mingw.thread.h threads in MinGW 2020-01-16 18:11:59 +01:00
mobile.cpp vertical sliders work on Android 2023-12-30 08:10:52 +01:00
models.cpp new projection: polar coordinates 2024-02-22 01:16:43 +01:00
monstergen.cpp Asteroids now has some gameplay in non-shmup 2024-03-14 19:52:22 +01:00
monstermove.cpp achievement eligibility display 2023-12-15 11:00:41 +01:00
multi.cpp fixed some more crashes related to SDL2 (e.g., right-click in shmup) 2024-03-27 16:28:37 +01:00
multigame.cpp hopefully fixed yet another C++20 bug 2024-05-16 21:21:13 +02:00
mymake.cpp mymake:: improved the web compilation 2023-04-15 01:29:59 +02:00
netgen.cpp Eliminate calls to `sprintf` 2023-08-21 10:18:44 -07:00
nofont.cpp fixes to nofont.cpp 2023-04-11 18:13:38 +02:00
nonisotropic.cpp fixed errors about underlying_map uninitialized 2024-05-16 21:21:14 +02:00
orbgen.cpp Change `static const` to `static constexpr` wherever possible 2023-08-23 09:47:28 -08:00
orbs.cpp Orb of Summoning now works on deep water, shallow water, and Camelot moat tiles 2024-05-09 10:44:37 +02:00
papermodeldata-help.txt papermodeldata files added 2019-05-16 09:42:22 +02:00
papermodeldata.txt papermodeldata files added 2019-05-16 09:42:22 +02:00
passable.cpp fixed rosebush/crystal world interaction 2024-05-10 19:10:44 +02:00
pattern2.cpp threecolor now uses its own ctab, not nestcolors 2024-05-10 19:34:01 +02:00
patterns.cpp exporting necessary stuff all over (in progress) 2019-09-12 22:50:16 +02:00
pcmove.cpp Orb of Earth now cancels Invisibility only if it is doing something 2024-05-09 10:44:37 +02:00
polygons.cpp crossbow:: shapes 2023-10-28 09:51:27 +02:00
quit.cpp Fix minor menu glitches. 2024-05-16 07:12:28 -07:00
quotient.cpp new geometry gHalfBring 2021-09-30 12:04:26 +02:00
racing.cpp debug removed 2024-05-16 21:42:49 +02:00
radar.cpp display Orb of Yendor beacon on radar 2024-05-09 21:07:44 +02:00
raycaster.cpp ray:: improved ODS 2023-11-30 12:38:30 +01:00
reg3.cpp fixed a bug in celldistance_534 2024-05-09 10:44:37 +02:00
renderbuffer.cpp fixed renderbuffer from SDL 2022-04-26 16:19:02 +02:00
rug.cpp rug mouseover:: fix incorrect points in perspective; fix points behind eye in perspective; fix reverse Z in non-perspective (VR presumed fine) 2023-12-02 12:27:04 +01:00
rulegen.cpp rulegen:: no crash if no giver 2024-03-19 18:53:37 +01:00
rulegen3.cpp rulegen:: optimize in 2D, also debug information during optimize is toggleable 2024-03-19 18:53:09 +01:00
savemem.cpp fixed constant name 2024-01-11 17:22:20 +01:00
savepng.cpp fixup to mymake/savepng 2021-03-07 14:06:11 +01:00
savepng.h Updated to 8.3j 2016-08-26 11:58:03 +02:00
scores.cpp fixed a possible crash with bad Steam data 2024-05-05 15:10:45 +02:00
screenshot.cpp screenshots centered 2024-01-07 09:13:44 +01:00
shaders.cpp 'cylidrical' stereo mode 2024-01-07 09:13:31 +01:00
shmup.cpp auto-pause game when it loses focus 2024-04-08 00:45:20 +02:00
shyp-geodesics.dat updated geodesic tables 2020-04-17 21:01:31 +02:00
sky.cpp fixed two-eye rendering in stereo modes which should not cause that 2024-01-07 09:07:54 +01:00
solv-geodesics.dat updated geodesic tables 2020-04-17 21:01:31 +02:00
sound.cpp find_file to find files in HYPERPATH 2022-08-26 12:23:58 +02:00
source-doc.md Doxygen files added 2019-09-12 23:35:04 +02:00
sphere.cpp fixed a crash with irregular spherical maps 2024-05-05 15:11:07 +02:00
ssol-geodesics.dat updated geodesic tables 2020-04-17 21:01:31 +02:00
surface.cpp more OOP-style standard dialogs 2023-08-09 14:01:24 +02:00
sysconfig.h cleaned up stereo/high-FOV projections 2023-11-30 12:32:24 +01:00
system.cpp Remove trailing whitespace from system.cpp 2024-05-16 09:13:48 -07:00
textures.cpp redone the canvas coloring system 2024-05-09 10:44:37 +02:00
tour.cpp redone the canvas coloring system 2024-05-09 10:44:37 +02:00
usershapes.cpp Qualify calls to `format` 2023-08-21 10:18:44 -07:00
util.cpp Change `static const` to `static constexpr` wherever possible 2023-08-23 09:47:28 -08:00
vr.cpp fixed VR demos 2023-12-02 08:27:38 +01:00
wfcgen.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
yendor.cpp Removed references to private/daily.cpp and private/hypersteam.cpp. Also removed HAVE_ACHIEVEMENTS as it was redundant to CAP_ACHIEVE 2024-05-16 21:21:13 +02:00

README.md

HyperRogue

A puzzle roguelike in the hyperbolic plane. See the HyperRogue website for detailed and most up-to-date information. Compiled executables can be downloaded from itch.io and from the HyperRogue website.

Released under GNU General Public License, version 2. As such, it comes without any warranty.

If you would like to thank me for HyperRogue, you can support the development by buying paid versions (with more up-to-date content and some social and competitive features), or in other ways. You can contact me at zeno@attnam.com, or at my blog, or via Twitter.

The game

You are a lone outsider in a strange, non-Euclidean world. You can move with the numpad, vi keys (hjklyubn), or mouse. You can also skip turns by pressing ".".

As a Rogue, your goal is to collect as many treasures as possible. However, collecting treasures attracts dangerous monsters (on the other hand, killing the monsters allows more treasures to be generated).

You can kill most monsters by moving into them. Similarly, if the monster was next to you at the end of your turn, it would kill you. The game protects you from getting yourself killed accidentally by ignoring moves which lead to instant death (similar to the check rule from Chess).

Ultimately, you will probably run into a situation where monsters surround you. That means that your adventure is over, and you will have to teleport back to the Euclidean world to survive by pressing Escape (quit).

Collecting enough treasure also allows you to find rare magical orbs, which grant you one-time or time-limited special abilities.

The world is a combination of over 60 types of lands. Each land type has specific style (monsters, treasure, magical orbs, terrain features). Collecting treasures only attracts more monsters in lands of the same type, so you can try to collect lots of treasure in several different lands!

Some of these lands are available from the beginning, others can be found only if you have proven yourself (press ESC to know what you should do to access more lands). Ultimately, you will be able to access Hell, and look for the fabulous Orbs of Yendor which are hidden there. Get at least one of them to prove that you are a true winner! Only the best players will be able to face the challenges of Hell, but both the monsters and the challenges associated with the Orbs of Yendor are different than in the rest of the game, so it should be worth it.

You can see tooltips by placing the mouse over stuff. You can also right click to get more information about game objects.

Press v to configure the game. You can also rotate the world by pressing arrow keys, PageUp and PageDn (not numpad). You can center on the PC by pressing Home.

Your scores and other stats about your games are recorded to file hyperrogue.log (in Linux, ~/.hyperrogue.log). You can save your configuration to file hyperrogue.ini (in Linux, ~/.hyperrogue.ini).

The surface the game is played on is called a hyperbolic plane. It seems there is just a very small amount of games and other works of art which use hyperbolic geometry (the most well known are some works of M.C. Escher).

The game dynamically generates new parts of the world as you move. Due to nature of the hyperbolic plane, the chances that you get back to a place where you have been before are very low (unless you go back exactly the same way). See more information about the geometry used on the blog.

You can aim for the Orb of Yendor, or you can simply aim for as high score as possible.

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).

RogueViz

HyperRogue uses RogueViz, 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. RogueViz is funded by the National Science Centre, Poland, grant UMO-2019/35/B/ST6/04456.

Development

Build prerequisites

On Linux with apt-get:

sudo apt-get install make g++ libsdl1.2-dev libsdl-ttf2.0-dev libsdl-gfx1.2-dev libsdl-mixer1.2-dev libglew-dev

On macOS with Homebrew:

brew install sdl sdl_ttf sdl_gfx sdl_mixer glew libpng

Building HyperRogue from source

git clone https://github.com/zenorogue/hyperrogue.git hyperrogue
cd hyperrogue
HYPERROGUE_USE_GLEW=1 HYPERROGUE_USE_PNG=1 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). Compiler flags like -Werror (treat warnings as errors) and -march=native work too.

make mymake && ./mymake

The source code is not documented very well. You can see the current state of the documentation, as generated by Doxygen, here.

Discussion

The best place to discuss HyperRogue is our [Discord server|https://discord.com/invite/8G44XkR].