abstreet/docs/INSTRUCTIONS.md

# A/B Street Instructions

This is an alpha-quality demo. Please email <dabreegster@gmail.com> or
[file a Github issue](https://github.com/dabreegster/abstreet/issues/) if you
hit problems.

## Installing the game

Grab a pre-built binary release -- updated every Sunday, announced at
[r/abstreet](http://old.reddit.com/r/abstreet):

- Windows:
  https://github.com/dabreegster/abstreet/releases/download/v0.1.43/abstreet_windows_v0_1_43.zip
- Mac:
  https://github.com/dabreegster/abstreet/releases/download/v0.1.43/abstreet_mac_v0_1_43.zip
- Linux:
  https://github.com/dabreegster/abstreet/releases/download/v0.1.43/abstreet_linux_v0_1_43.zip

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.

Or you can [build from source](/docs/dev.md).

## Playing the game

- Use the **tutorial** to learn the controls.
- Play the **challenges** for directed gameplay. As of June 2020, these're under
  active development.
- Try out any ideas in the **sandbox**.

## Data source licensing

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

- OpenStreetMap (https://www.openstreetmap.org/copyright)
- King County metro
  (https://www.kingcounty.gov/depts/transportation/metro/travel-options/bus/app-center/terms-of-use.aspx)
- City of Seattle GIS program
  (https://www.opendatacommons.org/licenses/pddl/1.0/)
- https://github.com/seattleio/seattle-boundaries-data
  (https://creativecommons.org/publicdomain/zero/1.0/)
- Puget Sound Regional Council
  (https://www.psrc.org/activity-based-travel-model-soundcast)
- USGS SRTM

Other binary data bundled in:

- Overpass font (https://fonts.google.com/specimen/Overpass, Open Font License)
- Bungee fonts (https://fonts.google.com/specimen/Bungee, Open Font License)
- Material Design icons (https://material.io/resources/icons, Apache license)
windows runner script to capture STDOUT 2019-04-10 22:48:46 +03:00			`# A/B Street Instructions`

remove the defunct bus challenge for now. hide the traffic signal challenge. fix up the cutscene style a bit. 2020-04-12 21:20:22 +03:00			`This is an alpha-quality demo. Please email <dabreegster@gmail.com> or`
new release 2019-12-15 22:46:01 +03:00			`[file a Github issue](https://github.com/dabreegster/abstreet/issues/) if you`
			`hit problems.`
filling out some instructions for the binary releases. also writing down some interview questions / actual tasks for a UX person I'd love to hire. :) 2019-04-12 21:38:25 +03:00
start a script to package data, stick it in dropbox, suck it down for fast bootstrapping. split off developer instructions. not finished, because I need a better connection to upload the seed data and test everything... 2019-12-04 01:31:00 +03:00			`## Installing the game`

new release 2019-12-15 22:46:01 +03:00			`Grab a pre-built binary release -- updated every Sunday, announced at`
			`[r/abstreet](http://old.reddit.com/r/abstreet):`
actually, just make this be an article overviewing features of a/b st. and start to tie together other pages... 2019-04-17 02:06:45 +03:00
link to binary releases and patreon and slightly rearrange main article 2019-04-19 19:46:28 +03:00			`- Windows:`
new release 2020-06-01 03:59:15 +03:00			`https://github.com/dabreegster/abstreet/releases/download/v0.1.43/abstreet_windows_v0_1_43.zip`
new release 2019-11-11 06:08:35 +03:00			`- Mac:`
new release 2020-06-01 03:59:15 +03:00			`https://github.com/dabreegster/abstreet/releases/download/v0.1.43/abstreet_mac_v0_1_43.zip`
slightly clarify install instructions 2019-11-10 22:38:39 +03:00			`- Linux:`
new release 2020-06-01 03:59:15 +03:00			`https://github.com/dabreegster/abstreet/releases/download/v0.1.43/abstreet_linux_v0_1_43.zip`
fill out more of the main article 2019-04-18 00:49:51 +03:00
slightly clarify install instructions 2019-11-10 22:38:39 +03:00			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.`
add basic usage instructions 2019-10-22 22:27:47 +03:00
start a script to package data, stick it in dropbox, suck it down for fast bootstrapping. split off developer instructions. not finished, because I need a better connection to upload the seed data and test everything... 2019-12-04 01:31:00 +03:00			`Or you can [build from source](/docs/dev.md).`

slightly clarify install instructions 2019-11-10 22:38:39 +03:00			`## Playing the game`
add basic usage instructions 2019-10-22 22:27:47 +03:00
tightening up more tutorial stages: - spawn a better amount of trips for low parking - adjust contention stage so there's only one real problem to fix also try to fix building the new clipboard dep [rebuild] 2020-06-08 02:59:20 +03:00			`- Use the tutorial to learn the controls.`
reviving tutorial... - pick another building, now that the montlake market is demolished - layouting (i understand flexbox now \o/) - finally listen to reason and get rid of the extra "inspect" action. not many per-object actions remaining at this point - handle window resizing much better, making the --tutorial flag useful again 2020-06-04 03:38:02 +03:00			`- Play the challenges for directed gameplay. As of June 2020, these're under`
prep release [rebuild] 2020-05-03 22:53:06 +03:00			`active development.`
remove the defunct bus challenge for now. hide the traffic signal challenge. fix up the cutscene style a bit. 2020-04-12 21:20:22 +03:00			`- Try out any ideas in the sandbox.`
add basic usage instructions 2019-10-22 22:27:47 +03:00
windows runner script to capture STDOUT 2019-04-10 22:48:46 +03:00			`## Data source licensing`

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

			`- OpenStreetMap (https://www.openstreetmap.org/copyright)`
			`- King County metro`
			`(https://www.kingcounty.gov/depts/transportation/metro/travel-options/bus/app-center/terms-of-use.aspx)`
			`- City of Seattle GIS program`
			`(https://www.opendatacommons.org/licenses/pddl/1.0/)`
			`- https://github.com/seattleio/seattle-boundaries-data`
			`(https://creativecommons.org/publicdomain/zero/1.0/)`
refresh front-page README. still need to take new GIFs 2019-06-25 23:01:32 +03:00			`- Puget Sound Regional Council`
			`(https://www.psrc.org/activity-based-travel-model-soundcast)`
bring back elevation data before the hackathon. manual revert of 35b7c18df9b820b67ba0b9ce51880c8609adc1e6 2020-03-11 21:06:10 +03:00			`- USGS SRTM`
adding roboto 2019-11-29 21:17:14 +03:00
			`Other binary data bundled in:`

ありがとう, Mr Roboto. You've served us well, but switch to Overpass 2020-04-01 19:32:52 +03:00			`- Overpass font (https://fonts.google.com/specimen/Overpass, Open Font License)`
typography overhaul... [rebuild] 2020-03-27 01:42:37 +03:00			`- Bungee fonts (https://fonts.google.com/specimen/Bungee, Open Font License)`
skip to end of commute challenge as soon as last trip is done. show sentiment of matching goal so far or not 2020-04-16 22:49:36 +03:00			`- Material Design icons (https://material.io/resources/icons, Apache license)`