Return to README.md CVS log

Up to [contributed] / brogue-ce

Initial revision

Brogue CE
=========

> *Countless adventurers before you have descended this torch-lit staircase,
> seeking the promised riches below. As you reach the bottom and step into
> the wide cavern, the doors behind you seal with a powerful magic...*
>
> ***Welcome to the Dungeons of Doom!***

*Brogue* is a single-player strategy game set in the halls of a mysterious
and randomly-generated dungeon. The objective is simple enough -- retrieve the
fabled Amulet of Yendor from the 26th level -- but the dungeon is riddled with
danger. Horrifying creatures and devious, trap-ridden terrain await. Yet it is
also riddled with weapons, potions, and artifacts of forgotten power. Survival
demands strength and cunning in equal measure as you descend, making the most
of what the dungeon gives you. You will make sacrifices, narrow escapes,
and maybe even some friends along the way -- but will you be one of the
lucky few to return alive?

- [Wiki](https://brogue.fandom.com/wiki/Brogue_Wiki)
- [Forum (Reddit)](https://www.reddit.com/r/brogueforum/)
- [Roguelikes Discord](https://discord.gg/9pmFGKx) (we have a #brogue channel)
- IRC: ##brogue on Freenode
- [Original website](https://sites.google.com/site/broguegame/)


Playing
-------

If you downloaded a release, you can open the game as follows:

### Windows

Go to the `bin` folder and run `brogue.exe`.

### Mac

Run the included app.

As it's an unsigned program, you may have to convince macOS to let you run it.
You can do this by right-clicking the app and choosing *Open* the first time you
run it.

### Linux

Run the `./brogue` script in the same the folder as this file.

Make sure you have SDL2 and SDL2_image installed via your package manager. The
required packages are:

- Debian/Ubuntu: `libsdl2-2.0-0 libsdl2-image-2.0-0`
- Fedora: `SDL2 SDL2_image`
- Arch: `sdl2 sdl2_image`

You can also run `./make-link-for-desktop.sh` to generate a .desktop file to
place on your desktop or applications folder.

### More information

If you're running the graphical version (default), the game window can be
resized using the PageDown/PageUp or -/+ keys. Graphical tiles are included;
press 'G' to toggle them.

For some tips on playing the game, see the original website, linked above. Also
check out the wiki -- although this version contains some modifications from
what the wiki reports!

If you downloaded the source code, you will need to build the game first. For
instructions, see `BUILD.md`.

On Windows, if you want to run from the command prompt, use `brogue-cmd.bat`
instead of `brogue.exe`.


About
-----

### What is Community Edition?

Brogue was created by Brian Walker. This version, *Brogue: Community Edition*,
is a continuation of its development. It has several main goals:

- fix bugs and crashes
- add useful quality of life and non-gameplay features
- make conservative game changes, where there is wide agreement
- be an uncontroversial drop-in for the original game
- ease development and maintenance
- be a convenient base for forks and ports to new platforms

### How is CE different from the original Brogue?

All the changes we've made are consistent with our goals above, so overall it is
quite similar. We don't maintain a complete list, so please refer to the
changelog or release history.

### How is the project run, and how are changes decided?

The project is run with a "benevolent dictator" model, with myself (tmewett) in
charge. There are many other testers and regular contributors; see the
contribution guide (CONTRIBUTING.md) to get involved!

Most changes are bug fixes or not gameplay related, so are not subject to much
critique. On the rarer occasions where we consider game changes, I try and use
the existing design and feature-set as a reference, as well as testing from both
new and experienced players. I also compile stats/probabilities about what we
want to change and try and tweak them to be slightly weaker, stronger, or the
same, depending on the desired result. The results are subject to testing.

### What will you do if Brogue is updated?

We're not sure! Most likely CE will be "rebased" to include the new changes
while keeping any of the new features and fixes that were not included. It may
decrease the popularity of CE and perhaps the project will no longer be
necessary.

We don't know for sure whether Brian is still working on Brogue, or plans to
release another version. However, he has implied that he considers the game
complete, so we are working on the assumption that 1.7.5 is the final version.