Resource gathering + programming game
Go to file
Brent Yorgey 902ceda8ad
Create and use lenses for ProcessedTerm and Module (#1866)
Splitting out an independent refactoring to simplify #1865.  There were many places in the code where we were pattern-matching on `ProcessedTerm` and/or `Module`, sometimes only to extract a single field, *e.g.*
```
ProcessedTerm (Module s _) _ _ <- maybeInitialCode
```
This was already getting a bit out of hand, and it also meant that any time we wanted to add an extra field to either `ProcessedTerm` or `Module` (as I will be doing in #1865), we would have to change every single such place in the code to add an extra wildcard pattern.

This PR is a refactoring to
1. Derive lenses for all the fields of `ProcessedTerm` and `Module`, and
2. Prefer extracting named fields via lenses over pattern-matching in most places in the code.

There were a few places in the code where we destructure a `ProcessedTerm` and use almost all the fields (e.g. when initializing a robot machine); I left those alone, first because extracting all the individual fields would be tedious, but more importantly because if we ever added any new fields in the future, it's likely we would actually want to use them in those contexts as well.
2024-05-28 01:14:51 +00:00
.github Bump checkout and setup-node actions to v4 (#1853) 2024-05-18 13:29:50 +00:00
.vscode extensible terrain (#1775) 2024-02-29 06:22:21 +00:00
app Implement GitHub authentication (#1856) 2024-05-22 00:27:21 +00:00
data spreadable plant growth (#1817) 2024-05-26 20:50:27 +00:00
docs Update sublibrary graph generation script & cabal description (#1849) 2024-05-13 17:25:00 +00:00
editors spreadable plant growth (#1817) 2024-05-26 20:50:27 +00:00
example Require types to start with an uppercase letter (#1583) 2024-05-21 04:16:32 +00:00
images 0.4 release blog post (#1444) 2023-08-22 12:35:05 -05:00
scripts Update sublibrary graph generation script & cabal description (#1849) 2024-05-13 17:25:00 +00:00
src Create and use lenses for ProcessedTerm and Module (#1866) 2024-05-28 01:14:51 +00:00
test spreadable plant growth (#1817) 2024-05-26 20:50:27 +00:00
tournament Implement GitHub authentication (#1856) 2024-05-22 00:27:21 +00:00
web Render command matrix (#1658) 2024-01-26 01:02:14 +00:00
.gitignore refactoring towards tournament server (#1801) 2024-04-22 18:55:06 +00:00
.hlint.yaml Upload and parse scenarios (#1798) 2024-04-25 20:11:11 +00:00
.mergify.yml Support GHC 9.8, bump upper bounds, and update CI (#1828) 2024-05-10 14:43:41 -05: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 Support GHC 9.8, bump upper bounds, and update CI (#1828) 2024-05-10 14:43:41 -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 Minor update to CONTRIBUTING.md (#1862) 2024-05-22 13:22:27 +00:00
cspell.json autopopulate spellchecker (#1749) 2024-01-28 01:54:13 +00:00
DESIGN.md More minor edits (#693) 2022-09-18 12:04:33 +00:00
feedback.yaml Parse comments (#1838) 2024-05-12 00:32:21 +00:00
fourmolu.yaml World description DSL (#1376) 2023-08-17 11:08:42 +00:00
hie.cabal.yaml Recommend cabal (#1822) 2024-05-06 00:09:33 +00:00
hie.stack.yaml Recommend cabal (#1822) 2024-05-06 00:09:33 +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 Recommend cabal (#1822) 2024-05-06 00:09:33 +00:00
scenarios Documentation for scenario file format (#612) 2022-07-30 08:02:11 -04:00
stack.yaml Dependency updates (#1765) 2024-02-12 20:04:28 +00:00
swarm.cabal structure grid expansion (#1826) 2024-05-26 01:25:54 +00: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 cabal 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 a supported version of GHC:

      ghcup install ghc 9.6.4
      
    3. Use ghcup to install cabal:

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

    cd /path/to/the/swarm/repo
    cabal run -O0 swarm:exe:swarm
    

    (Note that we recommend turning off optimizations with -O0 since they don't seem to make much difference to the speed of the resulting executable, but they make a big difference in compilation time.)

  4. Go get a snack while cabal downloads and builds 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.