civng

Civ 5 implementation in Rust with a text-based UI, because, why not?

Were you ever like "God is Civ 5 slow to load!" and wished you could play the game without fancy graphics? Or wished you could play Civ on your small netbook? Yeah, me neither, but I needed a reason to dash head-first into this folly.

Ok, I know, I'm crazy and I'm never going to finish this, but then, what the hell it's so much fun to implement.

Current status

Very early. Features:

• Text-based hexagonal tiles UI.
• Loads ".Civ5Map" files.
• Move your units (blue) around.
• Fight enemy units (red).
• Nice pre/post combat dialogs with neat info.
• Some combat modifiers, such as terrain and flanking.
• Basic terrain types, with some of them impassable.
• Map scrolling.
• Turns, with limited movements in each one.
• Active unit is colored and its reachable cells are highlighted in yellow.
• Move mode allowing to step over friendly units.
• Overhead terrain map.
• Unit types: Melee and Ranged.
• Bombard action for Ranged units.

Requirements

• Rust 1.9
• A terminal using a font that supports Unicode box-drawing characters

Dependencies (automatically installed by cargo):

• Rustty for terminal output.
• num because native integers have very limited capabilities.
• byteorder for Civ5Map format destructuring.

Build

To build civng, make sure you have all requirements, then do:

git clone https://github.com/hsoft/civng.git
cd civng
cargo build
./target/debug/civng

You have to run the executable at the root of the project because paths for some needed resources are hardcoded.

Tests & documentation

There are a couple of doctests which you can run with:

cargo test

You can also generate an API documentation with:

cargo doc

and then open target/doc/civng/index.html.

Hex cells orientation

In Civ 5, hex cells are "pointy topped", but in civng, our cells are "flat topped". This is because it's much harder to ascii-draw a good-looking pointy-topped cell than a flat topped one. This changes significantly how maps look, but it shouldn't affect gameplay.

Usage

The app starts with the top left cell of the screen being the top left cell of the map. You have two units, the blue M and R (Melee and Ranged) which move in turns. You can move it with w/a/s/d/q/e or with the numpad with numlock turned on.

Each unit has two movements per turn. You can cycle through active units with .. You start a new turn by pressing Return.

The cells highlighted in yellow around the active units are cells where that unit can move this turn. You can press m to active the "Move Mode" which enabled a blue cell selector. Move this selector around freely (it doesn't move the unit right away) and press Return when you've selected your destination. Press m again to cancel.

If you move on a tile with an enemy unit on it, you initiate a melee attack automatically. If you win, you move on the enemy's tile.

If the active unit is a Ranged unit, you can press b to bombard. Target tile selection works exactly like the Move mode, except that pressing Return on an enemy triggers a ranged attack instead.

Water ~ and mountains A are impassable. Hills ^ use up 2 movement points.

You can toggle position markers (mostly for debugging purposes) with shift-p.

You can scroll the map! To do so, press shift-s to toggle scroll mode. Now, when you press movement keys, it's the map that will scroll instead of the active unit. When you reach limits of the map, you'll see red borders. That's when you can't scroll any further.

To toggle the overhead map, press z. This will show terrain features of the current map in a one-char-is-one-tile fashion. Press z again to return to the normal map.

shift-q to quit.