swarm-game/swarm
1
1
Fork 0
mirror of https://github.com/swarm-game/swarm.git synced 2025-01-05 23:34:35 +03:00
Code Issues Projects Releases Wiki Activity
Resource gathering + programming game
1,238 Commits 129 Branches 18 Tags 27 MiB
Haskell 48.7%
JavaScript 47.5%
Sway 2.8%
Shell 0.5%
HTML 0.2%
Other 0.1%
82e8ac95ad
Go to file
Karl Ostmo 82e8ac95ad
Implement GitHub authentication (#1856) 
Closes #1847.

## Demo

### Production
https://swarmgame.net/list-games.html

### Local testing
```
tournament/scripts/demo/server-native.sh
```
and

```
scripts/test/run-tests.sh swarm:test:tournament-host
```

## Authentication flow

1. Users are represented by a GitHub username (primary key) and an "authentication cookie" in the SQLite database.
2. Site prompts user to login when the client's cookie is nonexistent or does not match any user in the database.
3. GitHub flow:
    1. Clicking the "Login" link redirects user to the GitHub login page.
    2. GitHub sends a `code` to our callback URL.
    3. use that `code` to get an "access token"
    4. use the "access token" to look up the username of the person who is logging in.
    5. generate and store a new cookie in the database row for that username
    6. set the cookie value on the user's client.
4. As long as the client keeps sending the cookie value known to the server, all uploads/activity will be attributed to their GitHub username.

## New features

* Login/Logout
* All uploaded content is attributed to an authenticated GitHub user
* Separate pages for scenario lists and solution lists
* Download a solution file
2024-05-22 00:27:21 +00:00
.github Bump checkout and setup-node actions to v4 (#1853) 2024-05-18 13:29:50 +00:00
.vscode extensible terrain (#1775) 2024-02-29 06:22:21 +00:00
app Implement GitHub authentication (#1856) 2024-05-22 00:27:21 +00:00
data Require types to start with an uppercase letter (#1583) 2024-05-21 04:16:32 +00:00
docs Update sublibrary graph generation script & cabal description (#1849) 2024-05-13 17:25:00 +00:00
editors volume command (#1747) 2024-01-28 01:02:08 +00:00
example Require types to start with an uppercase letter (#1583) 2024-05-21 04:16:32 +00:00
images 0.4 release blog post (#1444) 2023-08-22 12:35:05 -05:00
scripts Update sublibrary graph generation script & cabal description (#1849) 2024-05-13 17:25:00 +00:00
src Implement GitHub authentication (#1856) 2024-05-22 00:27:21 +00:00
test Implement GitHub authentication (#1856) 2024-05-22 00:27:21 +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 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 Parse comments (#1838) 2024-05-12 00:32:21 +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 Implement GitHub authentication (#1856) 2024-05-22 00:27:21 +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.