Resource gathering + programming game
Go to file
Brent Yorgey 4be0f7359d
Refactor: move ResourceLoading to swarm-util (#2162)
Now that `Failure` is moved to `swarm-util` (#2155), that was the last remaining dependency of `Swarm.Game.ResourceLoading` which prevented it from moving as well.  The `ResourceLoading` code is not specific to Swarm scenarios; this PR moves it to `swarm-util` to make it more generally applicable.

In fact, the `ResourceLoading` code is already being used to load `.sw` files when executing the `Run` command; in order to implement #495 we will need to do that loading in order to resolve `import` expressions, but that code will live in `swarm-lang`, which cannot import `swarm-scenario`.
2024-09-30 18:12:34 +00:00
.github Generate github release executables for macos (#2046) 2024-09-16 18:31:42 +00:00
.vscode Move top-level Github/VSCode configuration files (#2037) 2024-07-14 15:41:23 +02:00
app Refactor: move ResourceLoading to swarm-util (#2162) 2024-09-30 18:12:34 +00:00
data Use the new wall in move tutorial (#2160) 2024-09-30 11:49:07 +00:00
docs topography sublibrary (#1836) 2024-06-02 20:53:34 +00:00
editors Add VSCode 0.1.2 changelog entry (#2075) 2024-07-23 00:24:14 +02:00
example Update integer list example (#2103) 2024-08-09 20:22:02 +00:00
images 0.4 release blog post (#1444) 2023-08-22 12:35:05 -05:00
scripts Fix growable structure grids for multiple children with negative coordinates (#2127) 2024-09-16 20:14:44 +00:00
src Refactor: move ResourceLoading to swarm-util (#2162) 2024-09-30 18:12:34 +00:00
test Refactor: move pretty-printing and failure code to swarm-util (#2155) 2024-09-29 22:04:10 +00:00
tournament fix local server test scripts (#2054) 2024-07-17 14:53:56 +00:00
web Migrate to v8 of pixi.js, vendor the library (#2144) 2024-09-15 00:57:40 +00:00
.gitignore Move top-level Github/VSCode configuration files (#2037) 2024-07-14 15:41:23 +02:00
.hlint.yaml navigable robots table (#2140) 2024-09-17 18:28:06 +00:00
.stan.toml exclude some stan observations 2021-09-15 06:39:21 -05:00
CHANGELOG.md 0.6 release (#1980) 2024-07-15 19:05:42 +00:00
CODE_OF_CONDUCT.md update references from IRC -> Discord (#2029) 2024-07-13 14:29:25 +00:00
COMMUNITY.md update references from IRC -> Discord (#2029) 2024-07-13 14:29:25 +00:00
CONTRIBUTING.md fix markdown link (#2067) 2024-07-21 17:44:22 +00:00
DESIGN.md More minor edits (#693) 2022-09-18 12:04:33 +00:00
feedback.yaml Don't set it variable when an exception was raised (#1922) 2024-06-10 19:14:45 +00:00
fourmolu.yaml World description DSL (#1376) 2023-08-17 11:08:42 +00:00
LICENSE Update copyright (#1973) 2024-06-23 03:59:08 +00:00
NOTICE Use a new opaque type for robots instead of strings (#303) 2022-03-02 03:00:44 +00:00
README.md 0.6 release (#1980) 2024-07-15 19:05:42 +00:00
scenarios Documentation for scenario file format (#612) 2022-07-30 08:02:11 -04:00
swarm.cabal Refactor: move ResourceLoading to swarm-util (#2162) 2024-09-30 18:12:34 +00:00
weeder.toml better transparency handling for structure recognizer (#2115) 2024-08-16 20:14:15 +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.8.2
      
    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.