swarm-game/swarm
1
1
Fork 0
mirror of https://github.com/swarm-game/swarm.git synced 2024-09-11 14:46:33 +03:00
Code Issues Projects Releases Wiki Activity
Resource gathering + programming game
1,226 Commits 125 Branches 18 Tags 26 MiB
Haskell 93.7%
Sway 3.6%
Shell 1%
JavaScript 0.6%
HTML 0.4%
Other 0.4%
62470f3513
Go to file
Brent Yorgey 62470f3513
Split out swarm-doc and swarm-tui sublibraries (#1834) 
Split the final remaining default library into `swarm-doc` and `swarm-tui`.  Closes #1043 .
2024-05-11 02:08:49 +00:00
.github Support GHC 9.8, bump upper bounds, and update CI (#1828) 2024-05-10 14:43:41 -05:00
.vscode extensible terrain (#1775) 2024-02-29 06:22:21 +00:00
app Split out swarm-doc and swarm-tui sublibraries (#1834) 2024-05-11 02:08:49 +00:00
data structure placement order (#1833) 2024-05-10 20:27:53 +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 subdirectories for more scripts (#1831) 2024-05-10 17:32:23 +00:00
src Split out swarm-doc and swarm-tui sublibraries (#1834) 2024-05-11 02:08:49 +00:00
test Fix child robot privileges (#1819) 2024-05-04 16:13:32 +00:00
tournament Upload and parse scenarios (#1798) 2024-04-25 20:11:11 +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 Recommend cabal (#1822) 2024-05-06 00:09:33 +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 Recommend cabal (#1822) 2024-05-06 00:09:33 +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 Split out swarm-doc and swarm-tui sublibraries (#1834) 2024-05-11 02:08:49 +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.