Annotation of brogue-ce/README.md, Revision 1.1
1.1 ! rubenllo 1: Brogue CE
! 2: =========
! 3:
! 4: > *Countless adventurers before you have descended this torch-lit staircase,
! 5: > seeking the promised riches below. As you reach the bottom and step into
! 6: > the wide cavern, the doors behind you seal with a powerful magic...*
! 7: >
! 8: > ***Welcome to the Dungeons of Doom!***
! 9:
! 10: *Brogue* is a single-player strategy game set in the halls of a mysterious
! 11: and randomly-generated dungeon. The objective is simple enough -- retrieve the
! 12: fabled Amulet of Yendor from the 26th level -- but the dungeon is riddled with
! 13: danger. Horrifying creatures and devious, trap-ridden terrain await. Yet it is
! 14: also riddled with weapons, potions, and artifacts of forgotten power. Survival
! 15: demands strength and cunning in equal measure as you descend, making the most
! 16: of what the dungeon gives you. You will make sacrifices, narrow escapes,
! 17: and maybe even some friends along the way -- but will you be one of the
! 18: lucky few to return alive?
! 19:
! 20: - [Wiki](https://brogue.fandom.com/wiki/Brogue_Wiki)
! 21: - [Forum (Reddit)](https://www.reddit.com/r/brogueforum/)
! 22: - [Roguelikes Discord](https://discord.gg/9pmFGKx) (we have a #brogue channel)
! 23: - IRC: ##brogue on Freenode
! 24: - [Original website](https://sites.google.com/site/broguegame/)
! 25:
! 26:
! 27: Playing
! 28: -------
! 29:
! 30: If you downloaded a release, you can open the game as follows:
! 31:
! 32: ### Windows
! 33:
! 34: Go to the `bin` folder and run `brogue.exe`.
! 35:
! 36: ### Mac
! 37:
! 38: Run the included app.
! 39:
! 40: As it's an unsigned program, you may have to convince macOS to let you run it.
! 41: You can do this by right-clicking the app and choosing *Open* the first time you
! 42: run it.
! 43:
! 44: ### Linux
! 45:
! 46: Run the `./brogue` script in the same the folder as this file.
! 47:
! 48: Make sure you have SDL2 and SDL2_image installed via your package manager. The
! 49: required packages are:
! 50:
! 51: - Debian/Ubuntu: `libsdl2-2.0-0 libsdl2-image-2.0-0`
! 52: - Fedora: `SDL2 SDL2_image`
! 53: - Arch: `sdl2 sdl2_image`
! 54:
! 55: You can also run `./make-link-for-desktop.sh` to generate a .desktop file to
! 56: place on your desktop or applications folder.
! 57:
! 58: ### More information
! 59:
! 60: If you're running the graphical version (default), the game window can be
! 61: resized using the PageDown/PageUp or -/+ keys. Graphical tiles are included;
! 62: press 'G' to toggle them.
! 63:
! 64: For some tips on playing the game, see the original website, linked above. Also
! 65: check out the wiki -- although this version contains some modifications from
! 66: what the wiki reports!
! 67:
! 68: If you downloaded the source code, you will need to build the game first. For
! 69: instructions, see `BUILD.md`.
! 70:
! 71: On Windows, if you want to run from the command prompt, use `brogue-cmd.bat`
! 72: instead of `brogue.exe`.
! 73:
! 74:
! 75: About
! 76: -----
! 77:
! 78: ### What is Community Edition?
! 79:
! 80: Brogue was created by Brian Walker. This version, *Brogue: Community Edition*,
! 81: is a continuation of its development. It has several main goals:
! 82:
! 83: - fix bugs and crashes
! 84: - add useful quality of life and non-gameplay features
! 85: - make conservative game changes, where there is wide agreement
! 86: - be an uncontroversial drop-in for the original game
! 87: - ease development and maintenance
! 88: - be a convenient base for forks and ports to new platforms
! 89:
! 90: ### How is CE different from the original Brogue?
! 91:
! 92: All the changes we've made are consistent with our goals above, so overall it is
! 93: quite similar. We don't maintain a complete list, so please refer to the
! 94: changelog or release history.
! 95:
! 96: ### How is the project run, and how are changes decided?
! 97:
! 98: The project is run with a "benevolent dictator" model, with myself (tmewett) in
! 99: charge. There are many other testers and regular contributors; see the
! 100: contribution guide (CONTRIBUTING.md) to get involved!
! 101:
! 102: Most changes are bug fixes or not gameplay related, so are not subject to much
! 103: critique. On the rarer occasions where we consider game changes, I try and use
! 104: the existing design and feature-set as a reference, as well as testing from both
! 105: new and experienced players. I also compile stats/probabilities about what we
! 106: want to change and try and tweak them to be slightly weaker, stronger, or the
! 107: same, depending on the desired result. The results are subject to testing.
! 108:
! 109: ### What will you do if Brogue is updated?
! 110:
! 111: We're not sure! Most likely CE will be "rebased" to include the new changes
! 112: while keeping any of the new features and fixes that were not included. It may
! 113: decrease the popularity of CE and perhaps the project will no longer be
! 114: necessary.
! 115:
! 116: We don't know for sure whether Brian is still working on Brogue, or plans to
! 117: release another version. However, he has implied that he considers the game
! 118: complete, so we are working on the assumption that 1.7.5 is the final version.
CVSweb
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to README.md CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [contributed] / brogue-ce