mirror of https://github.com/swarm-game/swarm.git synced 2024-09-11 14:46:33 +03:00

Resource gathering + programming game

Go to file

Karl Ostmo ecdf4f6698 new zoom function		2024-08-11 15:22:43 -07:00
.github	Add restore-keys logic for windows (#2050 )	2024-07-18 05:41:54 +00:00
.vscode	Move top-level Github/VSCode configuration files (#2037 )	2024-07-14 15:41:23 +02:00
app	Replace `ReadableIORef` with IO (#2098 )	2024-08-08 20:48:58 +00:00
data	Demo standalone colored structures (#2099 )	2024-08-08 20:33:40 +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	Minor script fixes (#2048 )	2024-08-05 16:21:33 +00:00
src	new zoom function	2024-08-11 15:22:43 -07:00
test	Only check for escaped skolem variables among those just generated (#2104 )	2024-08-09 19:39:05 +00:00
tournament	fix local server test scripts (#2054 )	2024-07-17 14:53:56 +00:00
web	remove pandoc dependency from main game (#2084 )	2024-07-30 00:57:36 +00:00
.gitignore	Move top-level Github/VSCode configuration files (#2037 )	2024-07-14 15:41:23 +02:00
.hlint.yaml	Use 'enumerate' from the 'extra' package (#2003 )	2024-07-01 00:12:01 +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	Replace `ReadableIORef` with IO (#2098 )	2024-08-08 20:48:58 +00:00
weeder.toml	Replace `TSyntax` with `Syntax` in a couple places, plus a bit of refactoring (#2074 )	2024-07-22 22:40:01 +00:00

README.md

Swarm

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.

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.

Clone the Swarm repository, e.g.

git clone https://github.com/swarm-game/swarm.git

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
```
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.)
Go get a snack while cabal downloads and builds all of Swarm's dependencies.
You might also want to check out the scripts directory, which contains an assortment of useful scripts for developers.