diff --git a/LICENSE b/LICENSE index 8c9da4d245..09c8d4b699 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 leomcelroy +Copyright (c) 2022 Hack Club Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index c5bb703956..bc6a3a6b14 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,35 @@ ## Hack Club Game Lab -sort of like a fantasy console, really just js. join `#gamelab-dev` on the hack club slack for the dev chat! +The Hack Club Game Lab is Hack Club's version of a [fantasy console](https://en.wikipedia.org/wiki/Fantasy_video_game_console) (ex. [PICO-8](https://www.lexaloffle.com/pico-8.php)), and designed to help run engaging Hack Club meetings! + +Inspired by [constuctionism](https://en.wikipedia.org/wiki/Constructionism_(learning_theory)), the idea behind Game Lab is to create a "microworld" where new club members are able to quickly build meaningful, engaging games through tinkering and with minimal prior coding or JavaScript knowledge. + +Design goals: + +- A new coder without any prior coding experience should be able to figure out how to build a game like Pong within an hour from looking at examples and tinkering +- New coders will generate ideas for their own games they feel they can build with Game Lab through looking at examples +- Experienced coders should have fun making games in Game Lab too! + +Join `#gamelab-dev` on the [Hack Club Slack](https://hackclub.com/slack/) to join the develpoment discussion! Screen Shot 2022-01-13 at 10 50 41 AM -[Superb Macedonian Plumber Bro](https://hackclub.github.io/game-lab/?file=recxJ4Z4C3U0WbSIT) +Check out a minimal example game: [Superb Macedonian Plumber Bro](https://hackclub.github.io/game-lab/?file=recxJ4Z4C3U0WbSIT) + +## Development + +The Hack Club Game Lab requires a local HTTP server to run in development. Here's how to get it running on your own machine. + +Clone repo: + + $ git clone https://github.com/hackclub/game-lab + +Start a local HTTP server inside the repo: + + $ cd game-lab/ + $ python3 -m http.server 3000 + +And then go to http://localhost:3000 in your web browser, and it should work! ## Minimal Examples @@ -317,3 +342,7 @@ e.add({ Screen Shot 2022-01-13 at 10 50 41 AM + +## License + +The Hack Club Game Lab is open source and licensed under the [MIT License](./LICENSE). Fork, remix, and make it your own! Pull requests and other contributions greatly appreciated.