Resource gathering + programming game
Go to file
Brent Yorgey e350ab8ae7
update to LTS-21.25 (#1708)
21.25 uses GHC 9.4.8 instead of 9.4.7; the latest HLS release supports 9.4.8 but not 9.4.7.
2024-01-04 22:12:36 +00:00
.github update to megaparsec-9.6.1 (#1609) 2023-11-08 12:26:23 -06:00
.vscode Account for symlink when applying JSON schemas (#1586) 2023-10-18 14:41:36 +00:00
app move ReadableIORef to util sublibrary (#1700) 2024-01-01 02:29:07 +00:00
data snake game (#1699) 2024-01-03 17:46:16 +00:00
docs/blog Update metadata after publishing latest blog post (#1445) 2023-08-22 17:51:30 +00:00
editors extract doc generator to separate executable (#1671) 2023-12-04 03:45:07 +00:00
example Key input handler (#1214) 2023-04-25 16:39:59 +00:00
images 0.4 release blog post (#1444) 2023-08-22 12:35:05 -05:00
scripts bump cabal-build version, fix haddock script (#1703) 2024-01-03 20:47:00 +00:00
src fix color of trees in main logo (#1707) 2024-01-04 22:00:58 +00:00
test snake game (#1699) 2024-01-03 17:46:16 +00:00
web demo pixi.js (#1650) 2023-12-20 06:41:38 +00:00
.gitignore Boolean expressions of objective prerequisites (#927) 2023-01-25 04:07:00 +00:00
.hlint.yaml more partial function bans (#1564) 2023-10-02 03:13:20 +00:00
.mergify.yml update to megaparsec-9.6.1 (#1609) 2023-11-08 12:26:23 -06:00
.restyled.yaml Fourmolu fixup (#1326) 2023-07-12 18:00:23 +00:00
.stan.toml exclude some stan observations 2021-09-15 06:39:21 -05:00
cabal.haskell-ci Update to support GHC 9.6, mtl-2.3, and bump upper bounds (#1363) 2023-07-11 19:05:14 -05:00
CHANGELOG.md 0.5 release (#1606) 2023-11-01 10:18:16 +00:00
CODE_OF_CONDUCT.md Adopt the Contributor Covenant Code of Conduct 2021-09-19 13:38:33 -05:00
COMMUNITY.md some updates to README and COMMUNITY 2022-10-05 17:52:52 -05:00
CONTRIBUTING.md update CONTRIBUTING guide, and remove info from README (#1512) 2023-09-23 21:46:04 +00:00
DESIGN.md More minor edits (#693) 2022-09-18 12:04:33 +00:00
feedback.yaml Records (#1148) 2023-03-25 11:58:34 +00:00
fourmolu.yaml World description DSL (#1376) 2023-08-17 11:08:42 +00:00
hie.yaml.stack Add cabal to HLS configuration (#131) 2021-10-03 21:14:04 +00:00
LICENSE Update editors (#581) 2022-07-25 00:16:23 +02:00
NOTICE Use a new opaque type for robots instead of strings (#303) 2022-03-02 03:00:44 +00:00
pull_request_template.md Add a pull request template (#1434) 2023-08-20 19:43:27 +00:00
README.md update CONTRIBUTING guide, and remove info from README (#1512) 2023-09-23 21:46:04 +00:00
scenarios Documentation for scenario file format (#612) 2022-07-30 08:02:11 -04:00
stack.yaml update to LTS-21.25 (#1708) 2024-01-04 22:12:36 +00:00
swarm.cabal sort module list (#1705) 2024-01-04 13:23:15 -08:00

Swarm

Build Status GitHub release (latest by date) Swarm release on Hackage Contributor Covenant ircchat GitHub Contributors

Swarm is a 2D programming and resource gathering game. Program your robots to explore the world and collect resources, which in turn allows you to build upgraded robots that can run more interesting and complex programs. More info can be found on the Swarm website.

World 0 after scanning a tree and making a log.

Contributing

See CONTRIBUTING.md for information about various ways you can contribute to Swarm development!

Building

If you just want to play the game, head over to the Swarm website for installation instructions. If you want to build Swarm from source (e.g. in order to contribute, or to test out the latest bleeding-edge unreleased features), read on.

  1. Clone the Swarm repository, e.g.

    git clone https://github.com/swarm-game/swarm.git
    
  2. If you don't already have the stack tool:

    1. Get the ghcup tool, a handy one-stop utility for managing all the different pieces of a Haskell toolchain.

    2. Use ghcup to install stack:

      ghcup install stack
      
  3. Now use stack to build and run Swarm:

    cd /path/to/the/swarm/repo
    stack run
    
  4. Go get a snack while stack downloads a Haskell compiler and all of Swarm's dependencies.

  5. You might also want to check out the scripts directory, which contains an assortment of useful scripts for developers.