swarm-game/swarm
1
1
Fork 0
mirror of https://github.com/swarm-game/swarm.git synced 2024-07-04 17:56:41 +03:00
Code Issues Projects Releases Wiki Activity
Resource gathering + programming game
1,305 Commits 115 Branches 16 Tags 21 MiB
Haskell 93.6%
Sway 3.8%
Shell 0.9%
JavaScript 0.7%
HTML 0.4%
Other 0.5%
main
Go to file
Brent Yorgey 9b1b6985fa
On C-c, only cancel base CESK if it is currently running (#2008) 
Fixes #2007.  After #1928, we handle exceptions a little differently, so it no longer works to simply set the base's CESK machine to an `Up` (exception) state no matter what.  Instead we have to first check if the base is running, and if so set it to `Up` as before; if not, do nothing (except clear the REPL prompt).
2024-07-01 19:04:43 +00:00
.github Add Windows build to CI (#1974) 2024-06-23 04:12:39 +00:00
.vscode extensible terrain (#1775) 2024-02-29 06:22:21 +00:00
app Generate operators for all editors (#1950) 2024-06-18 17:01:37 +00:00
data Change meetAll to return a list (#1999) 2024-06-27 19:56:16 +00:00
docs topography sublibrary (#1836) 2024-06-02 20:53:34 +00:00
editors Generate operators for all editors (#1950) 2024-06-18 17:01:37 +00:00
example Generate operators for all editors (#1950) 2024-06-18 17:01:37 +00:00
images 0.4 release blog post (#1444) 2023-08-22 12:35:05 -05:00
scripts Make structures parseable independently of entity definitions (#1924) 2024-06-15 18:21:39 +00:00
src On C-c, only cancel base CESK if it is currently running (#2008) 2024-07-01 19:04:43 +00:00
test nonempty grid rows (#1933) 2024-07-01 02:09:23 +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 Add hie.yaml to gitignore (#1975) 2024-06-23 19:02:07 +00:00
.hlint.yaml Use 'enumerate' from the 'extra' package (#2003) 2024-07-01 00:12:01 +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 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
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
swarm.cabal nonempty grid rows (#1933) 2024-07-01 02:09:23 +00:00

README.md

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.