mirror of https://github.com/swarm-game/swarm.git synced 2024-10-27 18:15:15 +03:00

Resource gathering + programming game

Go to file

Brent Yorgey c5255aeb97 get rid of `sepAttr` which is no longer needed		2021-09-23 18:16:24 -05:00
.github	Update issue templates	2021-09-19 22:16:54 -05:00
app	factor out remaining UI + app stuff	2021-08-23 16:52:40 -05:00
data	add a life support system to the initial base devices	2021-09-22 16:44:41 -05:00
example	convenience definition	2021-09-13 10:04:48 -05:00
images	display type of the REPL input in top right corner of panel	2021-09-23 14:23:03 -05:00
src/Swarm	get rid of `sepAttr` which is no longer needed	2021-09-23 18:16:24 -05:00
.gitignore	ignore HIE and stan stuff	2021-09-04 09:21:12 -05:00
.hlint.yaml	add a .hlint.yaml	2021-08-27 22:30:31 -05:00
.stan.toml	exclude some stan observations	2021-09-15 06:39:21 -05:00
CHANGELOG.md	new name: swarm	2021-08-23 11:47:04 -05:00
CODE_OF_CONDUCT.md	Adopt the Contributor Covenant Code of Conduct	2021-09-19 13:38:33 -05:00
CONTRIBUTING.md	a few more tweaks	2021-09-23 08:53:24 -05:00
DESIGN.md	some thoughts on design	2021-09-23 02:35:41 -05:00
LICENSE	clean up .cabal file and add LICENSE	2021-08-26 21:05:46 -05:00
README.md	minor updates	2021-09-23 08:44:15 -05:00
stack.yaml	tweaks to world, shift to spawn base at a tree	2021-09-04 07:19:22 -05:00
swarm.cabal	try allowing template-haskell-2.17 to build with GHC 9	2021-09-23 18:13:31 -05:00
TUTORIAL.md	display type of the REPL input in top right corner of panel	2021-09-23 14:23:03 -05: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.

The implementation is still in an early stage, but planned features include:

Practically infinite 2D procedurally generated worlds
Simple yet powerful programming language based on the polymorphic lambda calculus + recursion, with a command monad for describing first-class imperative actions
In-game tutorial
Multiple game modes:
- In Classic mode, you start with the ability to produce only very basic, limited robots; collecting resources allows you to bootstrap your way into programming more sophisticated robots that can explore more of the world, collect more resources, etc.
- Hardcore mode is like Classic mode, but you start with only a limited number of robots. If they get stuck or you run out of resources, it's game over!
- Sandbox mode places no restrictions: program robots to your heart's content using whatever language features you want, without worrying about collecting resources.
- In Challenge mode, you attempt to program robots in order to solve pre-designed puzzles or challenges.
- Future versions might also have multiplayer modes, with co-op or PvP play over a network...?

Installing and Playing

Warning: Swarm is still in an early stage; it's missing many of the planned features, there is no winning condition, and the gameplay is not very deep yet. But you can program cute little robots, and hey, that's all that really matters, right?

The recommended way to install Swarm at the moment is as follows:

Clone the Swarm repository, e.g.

git clone https://github.com/byorgey/swarm.git

If you don't already have the stack tool:
1. Get the ghcup tool.
2. Use ghcup to install stack:
```
ghcup install stack
```
Now use stack to build and run Swarm:
```
cd /path/to/the/swarm/repo
stack run
```
Go get a snack while stack downloads a Haskell compiler and all of Swarm's dependencies.
Have fun! You probably want to take a look at the tutorial to help get you started.

Contributing

If you want to help out, you're most welcome! There are lots of ways to contribute, regardless of your Haskell background. For example, even someone with no Haskell experience whatsoever could still help with e.g. game design, playtesting, and level design for challenge mode. Check out the CONTRIBUTING file for more specific information about how to contribute.