a-b-street/abstreet
1
1
Fork 0
mirror of https://github.com/a-b-street/abstreet.git synced 2024-12-23 22:42:32 +03:00
Code Issues Projects Releases Wiki Activity
10c291f7ed
abstreet/docs/INSTRUCTIONS.md
Dustin Carlino 10c291f7ed new release before hackathon
2019-11-22 19:06:00 -08:00

3.3 KiB
Raw Blame History

A/B Street Instructions

General disclaimer: This is a very rough demo. The user interface is clunky, and gameplay is not cohesively tied together yet. Please email dabreegster@gmail.com or file a Github issue if you hit problems.

Installing the game from pre-built binaries

Unzip the folder, then run play_abstreet.sh or play_abstreet.bat. On Windows, you'll probably get a warning about running software from an unknown publisher.

Playing the game

General controls:

  • Click and drag to move
  • Scroll wheel or touchpad to zoom
  • Menus should work as expected. Most actions have a keybinding.
  • You can hover over an object and right-click to see more actions.

Things to try:

  • In sandbox mode, hover over an intersection, right click, and spawn agents. Then you can start the simulation by pressing space or clicking the icon.
  • To run a realistic, full day's worth of traffic, go to sandbox mode, then "start a scenario" (hotkey s) and choose the "weekday_typical_traffic" entry. Time (shown in the top-right corner) starts at midnight. Things tend to get interesting around 6am -- use the speed controls in the top-left. Try zooming in for details, and zooming out to see an overview.
  • Go to edit mode (note this will reset the simulation). Pick a lane, right click, and change it to another type. You can also change which roads see a stop sign by right clicking the intersection, choosing to edit, hovering over a stop sign, and pressing space to toggle it. You can do the same for intersections with traffic signals.
  • Go back to the main menu and pick a challenge. Should be self-explanatory from there -- leave me feedbck if not.

For developers: Compiling from source

To build, you need a Linux-like environment with bash, wget, unzip, etc. You also osmconvert for the import script. At runtime if you want to use the screen-capture plugin, you need scrot.

  1. Install Rust, at least 1.38. https://www.rust-lang.org/tools/install

  2. Download the repository: git clone https://github.com/dabreegster/abstreet.git

  3. Download all input data and build maps. Compilation times will be very slow the first time. cd abstreet; ./import.sh && ./precompute.sh --release

  4. Then run the game: cd game; cargo run --release

Data source licensing

A/B Street binary releases contain pre-built maps that combine data from: