Resource gathering + programming game
Go to file
Karl Ostmo e7b8cfba31
check achievement robot requirements (#1751)
Closes #1726

There are now two entry points to obtain a `GameplayAchievement`:
* `grantAchievementForRobot`
* `grantAchievement`

The latter enforces that the achievement is applicable to the current game mode (i.e. creative), while the former makes an additional check for validity of system robots.

This is an improvement over the status quo, but note that it is still currently possible to make a coding error in which an achievement specifies a requirement of **not** being a system robot, but the site at which the achievement is granted only calls `grantAchievement`, bypassing the robot validity check.
2024-01-29 18:26:54 +00:00
.github enforce scenario normalization (#1718) 2024-01-06 01:21:21 +00:00
.vscode autopopulate spellchecker (#1749) 2024-01-28 01:54:13 +00:00
app extract scene renderer to its own binary (#1752) 2024-01-29 18:01:56 +00:00
data volume command (#1747) 2024-01-28 01:02:08 +00:00
docs split scenario construction into separate sublibrary (#1719) 2024-01-24 21:11:14 +00:00
editors volume command (#1747) 2024-01-28 01:02:08 +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 autopopulate spellchecker (#1749) 2024-01-28 01:54:13 +00:00
src check achievement robot requirements (#1751) 2024-01-29 18:26:54 +00:00
test extract scene renderer to its own binary (#1752) 2024-01-29 18:01:56 +00:00
web Render command matrix (#1658) 2024-01-26 01:02:14 +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
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 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 Depend only on vty-crossplatform (#1727) 2024-01-13 23:47:17 +00:00
swarm.cabal extract scene renderer to its own binary (#1752) 2024-01-29 18:01:56 +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 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.