A SDL roguelike in a non-euclidean world.
Go to file
Technochips 3dc7c3b086 FRENCH: gender flags, fixed a bunch of small stuff 2022-07-05 19:57:02 +02:00
.github/workflows Enable -Werror for CI 2022-06-29 21:58:11 +03:00
devmods rulegen:: tests improvements 2022-02-01 17:00:39 +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
hyperroid 12.0f 2021-08-05 13:49:41 +02:00
music fixed the new music 2021-06-09 05:49:54 +02:00
rogueviz rv::kohonen:: heatmap drawing 2022-07-05 16:04:19 +02:00
sounds sound credits updated 2020-07-08 16:09:28 +02:00
tessellations 12.0o 2022-04-28 00:03:41 +02:00
.gitignore Eliminate autotools/automake/configure. 2021-03-21 17:19:41 -04:00
.travis.yml Enable -Werror for CI 2022-06-29 21:58:11 +03:00
3d-models.cpp shadows supported in Euclidean 3D 2020-09-11 11:03:42 +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 Don't set -march=native and -Werror by default 2022-06-24 13:59:05 +03:00
Makefile.rv French language translation by @3raven 2022-07-01 14:11:14 -04:00
README.md documented new options in Readme 2022-07-05 02:56:15 +02:00
achievement.cpp moved dual geometry puzzle to RogueViz 2022-06-17 01:20:34 +02:00
arbitrile.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
archimedean.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
asonov.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
attack.cpp Orb of the Sword can now kill yourself through mirror or topology 2022-06-17 10:40:26 +02:00
barriers.cpp arb:: tes files with tree data provided work again 2022-06-23 10:36:37 +02:00
basegraph.cpp fixed SDL2 (with GLEW) on Windows 2022-06-10 18:45:15 +02:00
bigstuff.cpp An option to play on a disk (and use bounded space rules). Also renamed 'bounded' flag to 'closed' or similar, and improved Halloween 2022-05-21 13:08:42 +02:00
binary-tiling.cpp ray:: now works with Binary4 product 2021-10-10 00:40:22 +02:00
blizzard.cpp MAJOR CHANGE: replaced (transmatrix,band_shift) pair with shiftmatrix 2020-07-28 22:06:14 +02:00
cell.cpp fixed adj_minefield_cells_full 2022-06-08 18:00:00 +02:00
celldrawer.cpp fixed numerical_minefield display to darken numbers correctly 2022-06-08 18:00:28 +02:00
changelog.txt fixed the version number in changelog 2022-07-05 16:13:06 +02:00
checkmove.cpp Orb of the Sword can now kill yourself through mirror or topology 2022-06-17 10:40:26 +02:00
classes.cpp An option to play on a disk (and use bounded space rules). Also renamed 'bounded' flag to 'closed' or similar, and improved Halloween 2022-05-21 13:08:42 +02:00
colors.cpp refer to color by HTML name in commandline arguments 2021-10-17 09:18:31 +02:00
commandline.cpp CLI option -cview 2022-06-23 09:33:58 +02:00
complex.cpp sword attacks reflect in mirrors 2022-06-17 10:27:02 +02:00
complex2.cpp unified the Quest screen and Main menu. 2022-06-16 23:54:47 +02:00
config.cpp side for sightrange edit 2022-07-05 14:02:51 +02:00
content.cpp fixed the displayed unlock rule for Crossroads III in Casual 2022-03-27 22:47:50 +02:00
control.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
crystal.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
debug.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
dialogs.cpp darken the menu side of the screen 2022-07-05 14:00:51 +02: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 fixed write_in_space to use poly_outline 2022-06-08 18:00:43 +02:00
earcut.hpp Remove extra semis in struct defs 2021-06-28 22:33:08 -07:00
embuild.sh emscripten uses ZLIB 2020-03-07 04:47:10 +01:00
environment.cpp slime spill is now predictable when multiple colors hit the same cell at once 2022-04-26 16:19:02 +02:00
euclid.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
expansion.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
fake-mobile.cpp XGD: filled circles and start with clearscreen 2021-06-03 13:26:10 +02:00
fake.cpp more guard fixes 2022-05-10 08:53:58 +02:00
fieldpattern.cpp An option to play on a disk (and use bounded space rules). Also renamed 'bounded' flag to 'closed' or similar, and improved Halloween 2022-05-21 13:08:42 +02:00
flags.cpp added flags for Dice 2021-06-01 13:07:56 +02:00
floorshapes.cpp fixed some CAP guards 2022-05-06 19:54:55 +02:00
game.cpp show treasure bubbles in Dice Reserve 2022-06-23 13:46:34 +02:00
geom-exp.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
geometry.cpp added CAP_RAY guard to intra stuff 2022-05-09 15:09:23 +02:00
geometry2.cpp An option to play on a disk (and use bounded space rules). Also renamed 'bounded' flag to 'closed' or similar, and improved Halloween 2022-05-21 13:08:42 +02:00
glhr.cpp fixed SDL2 (with GLEW) on Windows 2022-06-10 18:45:15 +02:00
goldberg.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
graph.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
help.cpp fixed the help button in the pause menu 2022-07-05 11:51:32 +02:00
heptagon.cpp init_heptagon fixup 2021-07-04 11:27:37 +02:00
history.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
honeycomb-rules-344.dat reg3:: included tree rules for most hyperbolic honeycombs 2021-05-23 16:00:49 +02:00
honeycomb-rules-353.dat optimized the honeycomb rules by using the 'quotient' fieldpatterns 2021-05-23 16:00:49 +02:00
honeycomb-rules-354.dat reg3:: included tree rules for most hyperbolic honeycombs 2021-05-23 16:00:49 +02:00
honeycomb-rules-355.dat reg3:: included tree rules for most hyperbolic honeycombs 2021-05-23 16:00:49 +02:00
honeycomb-rules-435.dat optimized the honeycomb rules by using the 'quotient' fieldpatterns 2021-05-23 16:00:49 +02:00
honeycomb-rules-436.dat reg3:: included tree rules for most hyperbolic honeycombs 2021-05-23 16:00:49 +02:00
honeycomb-rules-534.dat optimized the honeycomb rules by using the 'quotient' fieldpatterns 2021-05-23 16:00:49 +02:00
honeycomb-rules-535.dat optimized the honeycomb rules by using the 'quotient' fieldpatterns 2021-05-23 16:00:49 +02:00
honeycomb-rules-536.dat reg3:: included tree rules for most hyperbolic honeycombs 2021-05-23 16:00:49 +02:00
hprint.cpp mapstreams:: now work with sstream too 2022-06-16 23:06:49 +02:00
hr-icon.ico Initialization with hyperrogue-66 2015-08-08 15:57:52 +02:00
hud.cpp expansion_analyzer is now in cgi 2021-12-11 23:28:05 +01:00
hyper-main.cpp hyper-main:: convenience functions for the shared library 2021-12-19 13:08:12 +01:00
hyper.cpp moved dual geometry puzzle to RogueViz 2022-06-17 01:20:34 +02:00
hyper.h FRENCH: gender flags, fixed a bunch of small stuff 2022-07-05 19:57:02 +02:00
hyper.rc 10.0n 2017-09-04 20:43:45 +02:00
hyper_function.h Add `explicit` and `override` consistently everywhere else. NFCI. 2021-07-11 18:03:08 -04:00
hyperpoint.cpp ultra-ideal vertices should work now 2022-04-26 16:19:02 +02:00
hyperrogue-music.txt fixed the new music 2021-06-09 05:49:54 +02:00
hyperweb.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
hypgraph.cpp Fix some compiler errors and a mistake in config.cpp. 2022-07-01 14:07:58 -04:00
inforder.cpp Add `explicit` and `override` consistently everywhere else. NFCI. 2021-07-11 18:03:08 -04:00
intra.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
inventory.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
irregular.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
items.cpp An option to play on a disk (and use bounded space rules). Also renamed 'bounded' flag to 'closed' or similar, and improved Halloween 2022-05-21 13:08:42 +02:00
kite.cpp Eliminate -Woverloaded-virtual warnings from Clang. NFCI. 2021-07-12 17:51:39 -04:00
landgen.cpp An option to play on a disk (and use bounded space rules). Also renamed 'bounded' flag to 'closed' or similar, and improved Halloween 2022-05-21 13:08:42 +02:00
landlock.cpp An option to play on a disk (and use bounded space rules). Also renamed 'bounded' flag to 'closed' or similar, and improved Halloween 2022-05-21 13:08:42 +02:00
langen.cpp FRENCH: gender flags, fixed a bunch of small stuff 2022-07-05 19:57:02 +02:00
language-cz.cpp run away from the lava 2022-04-26 16:19:02 +02:00
language-de.cpp fixed message about 9 types 2021-10-01 08:00:42 +02:00
language-fr.cpp FRENCH: gender flags, fixed a bunch of small stuff 2022-07-05 19:57:02 +02:00
language-pl.cpp fixed the Polish translation of the description of False Princess 2022-07-05 01:32:26 +02:00
language-ptbr.cpp fixed 'Orb of the Love' 2021-12-12 20:41:11 +01:00
language-ru.cpp run away from the lava 2022-04-26 16:19:02 +02:00
language-tr.cpp fixed message about 9 types 2021-10-01 08:00:42 +02:00
language.cpp FRENCH: gender flags, fixed a bunch of small stuff 2022-07-05 19:57:02 +02:00
legacy.cpp fixed extra semicolon 2022-02-27 01:16:42 +01:00
locations.cpp increased the value of special-move constants to >100 so that the limit on sides is indeed 120 2022-04-24 22:57:35 +02:00
makeh.cpp one more update for older compilers 2019-09-13 18:33:15 +02:00
mapeditor.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
mapeffects.cpp An option to play on a disk (and use bounded space rules). Also renamed 'bounded' flag to 'closed' or similar, and improved Halloween 2022-05-21 13:08:42 +02:00
menus.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +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 mobile:: fixed lmouseover_distant 2021-06-03 13:26:10 +02:00
models.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
monstergen.cpp moved dual geometry puzzle to RogueViz 2022-06-17 01:20:34 +02:00
monstermove.cpp ghosts prioritize attacking players over attacking allies 2022-06-17 10:56:31 +02:00
multi.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
multigame.cpp moved dual geometry puzzle to RogueViz 2022-06-17 01:20:34 +02:00
mymake.cpp remove -Werror and -march=native from mymake 2022-07-05 02:54:07 +02:00
netgen.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
nofont.cpp mymake now works with Emscripten 2020-10-12 01:28:50 +02:00
nonisotropic.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
orbgen.cpp Orb of Chaos is now forbidden in the Dungeon 2022-02-03 01:05:41 +01:00
orbs.cpp fixed Orbs not affecting slime 2022-06-17 10:46:13 +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 slime movement on nonorientable 2022-04-26 16:19:02 +02:00
pattern2.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
patterns.cpp exporting necessary stuff all over (in progress) 2019-09-12 22:50:16 +02:00
pcmove.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
polygons.cpp clear ext in prepare_shapes 2022-05-06 19:55:09 +02:00
quit.cpp fixed the help button in the pause menu 2022-07-05 11:51:32 +02:00
quotient.cpp new geometry gHalfBring 2021-09-30 12:04:26 +02:00
racing.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
radar.cpp multi:: radar works correctly in split_screen 2022-03-27 22:47:51 +02:00
raycaster.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
reg3.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
renderbuffer.cpp fixed renderbuffer from SDL 2022-04-26 16:19:02 +02:00
rug.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
rulegen.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
savemem.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02: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 choice of the land structure 2021-04-11 22:15:40 +02:00
screenshot.cpp startanims now can be disabled 2022-07-05 11:51:49 +02:00
shaders.cpp added comments for sl:: parameters, set them as param_, renamed steps to shader_iterations 2022-05-28 18:43:43 +02:00
shmup.cpp fixed race reset 2022-06-21 10:34:43 +02:00
shyp-geodesics.dat updated geodesic tables 2020-04-17 21:01:31 +02:00
sky.cpp multi:: radar works correctly in split_screen 2022-03-27 22:47:51 +02:00
solv-geodesics.dat updated geodesic tables 2020-04-17 21:01:31 +02:00
sound.cpp hooks_sync_music 2022-05-28 18:44:22 +02:00
source-doc.md Doxygen files added 2019-09-12 23:35:04 +02:00
sphere.cpp Eliminate -Woverloaded-virtual warnings from Clang. NFCI. 2021-07-12 17:51:39 -04:00
ssol-geodesics.dat updated geodesic tables 2020-04-17 21:01:31 +02:00
surface.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
sysconfig.h display a hint when player hidden 2022-03-27 22:47:51 +02:00
system.cpp moved dual geometry puzzle to RogueViz 2022-06-17 01:20:34 +02:00
textures.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
tour.cpp tour:: slide_action function 2022-02-27 14:51:02 +01:00
usershapes.cpp fixed some guards (in progress) 2020-07-03 14:42:33 +02:00
util.cpp fixed some CAP guards 2022-05-06 19:54:55 +02:00
vr.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
wfcgen.cpp made background screen darkening consistent and optional 2022-07-05 11:51:06 +02:00
yendor.cpp peace:: cleanup 2022-06-17 01:03:05 +02:00

README.md

HyperRogue

TravisCI badge TravisCI badge TravisCI badge

Current version: 11.3f

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

macOS users might also have to edit /usr/local/include/SDL/SDL_gfxPrimitives.h at line 38 to use quote include.

Building HyperRogue from source

git clone https://github.com/zenorogue/hyperrogue.git hyperrogue
cd hyperrogue
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.