codecombat/README.md

107 lines
9.6 KiB
Markdown
Raw Normal View History

# CodeCombat
2013-12-14 16:47:37 -05:00
<div style="text-align:center">
<a href="http://codecombat.com/">
<img src ="https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/readme_00.png" />
</a>
</div>
2014-01-12 14:42:49 -05:00
[![Build Status](https://travis-ci.org/codecombat/codecombat.png?branch=master)](https://travis-ci.org/codecombat/codecombat)
2014-01-03 14:13:06 -05:00
CodeCombat is a multiplayer programming game for learning how to code.
**See the [Archmage (coder) developer wiki](../../wiki/Archmage-Home) for a dev
setup guide, extensive documentation, and much more. Every new person that wants
to start contributing the project coding should start there.**
2014-01-03 13:32:13 -05:00
It's both a startup and a community project, completely open source under the
[MIT and Creative Commons licenses](http://codecombat.com/legal). It's the
largest open source [CoffeeScript](http://coffeescript.org/) project by lines of
code, and since it's a game (with [really cool tech](../../wiki/Third-party-software-and-services)),
it's really fun to hack on. Join us in teaching the world to code! Your
contribution will go on to show millions of players how cool programming can be.
2014-01-03 13:32:13 -05:00
### [Getting Started](../../wiki/Dev-Setup:-General-Information)
2014-01-05 15:32:44 -05:00
We've made it easy to fork the project, run a simple script that'll install all
the dependencies, and get a local copy of CodeCombat running right away on
[Mac](../../wiki/Dev-Setup:-Mac), [Linux](../../wiki/Dev-Setup:-Linux),
[Windows](../../wiki/Dev-Setup:-Windows), or [Vagrant](../../wiki/Dev-Setup:-Vagrant).
See [the docs for details](../../wiki/Dev-Setup:-General-Information).
2014-01-05 15:32:44 -05:00
### [Getting In Touch](../../wiki/Developer-organization)
2014-01-05 15:32:44 -05:00
Whether you're novice or pro, the CodeCombat team is ready to help you implement
your ideas. Reach out on our [forum](http://discourse.codecombat.com), our
[issue tracker](../../issues), or
[our developer chat room on Slack](https://coco-slack-invite.herokuapp.com/), or
see the docs for [more on how to contribute](../../wiki/Developer-organization).
2014-01-05 15:32:44 -05:00
2015-10-29 11:59:20 -04:00
[![Slack Status](https://coco-slack-invite.herokuapp.com/badge.svg)](https://coco-slack-invite.herokuapp.com/)
### [License](LICENSE)
2014-01-05 15:32:44 -05:00
[MIT](LICENSE) for the code, and [CC-BY](http://codecombat.com/legal) for the
art and music. Please also
[sign the CodeCombat contributor license agreement](http://codecombat.com/cla)
so we can accept your pull requests. It is easy.
### [Join Us!](http://blog.codecombat.com/why-you-should-open-source-your-startup)
![Nick Winter](http://codecombat.com/images/pages/about/nick_small.png "Nick Winter")
![George Saines](http://codecombat.com/images/pages/about/george_small.png "George Saines")
![Scott Erickson](http://codecombat.com/images/pages/about/scott_small.png "Scott Erickson")
![Matt Lott](http://codecombat.com/images/pages/about/matt_small.png "Matt Lott")
![Catherine Weresow](http://codecombat.com/images/pages/about/cat_small.png "Catherine Weresow")
![Maka Gradin](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Maka%20Gradin/maka_gradin_100.png "Maka Gradin")
![Rob Blanckaert](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Rob%20Blanckaert/rob_blanckaert_100.png "Rob Blanckaert")
![Josh Callebaut](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Josh%20Callebaut/josh_callebaut_100.png "Josh Callebaut")
![Michael Schmatz](http://codecombat.com/images/pages/about/michael_small.png "Michael Schmatz")
![Josh Lee](http://codecombat.com/images/pages/about/josh_small.png "Josh Lee")
![Alex Cotsarelis](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Alex%20Cotsarelis/alex_100.png "Alex Cotsarelis")
![Alex Crooks](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Alex%20Crooks/alex_100.png "Alex Crooks")
![Alexandru Caciulescu](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Alexandru%20Caciulescu/alexandru_100.png "Alexandru Caciulescu")
![Andreas Linn](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Andreas%20Linn/andreas_100.png "Andreas Linn")
![Andrew Witcher](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Andrew%20Witcher/andrew_100.png "Andrew Witcher")
![Axandre Oge](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Axandre%20Oge/axandre_100.png "Axandre Oge")
![Bang Honam](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Bang%20Honam/bang_100.png "Bang Honam")
![Benjamin Stern](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Benjamin%20Stern/benjamin_100.png "Benjamin Stern")
![Brad Dickason](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Brad%20Dickason/brad_100.png "Brad Dickason")
![Carlos Maia](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Carlos%20Maia/carlos_maia_100.png "Carlos Maia")
![Chloe Fan](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Chloe%20Fan/chloe_100.png "Chloe Fan")
![Dan Ristic](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Dan%20Ristic/dan_100.png "Dan Ristic")
![Danny Whittaker](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Danny%20Whittaker/danny_100.png "Danny Whittaker")
![David Liu](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/David%20Liu/david_liu_100.png "David Liu")
![David Pendray](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/David%20Pendray/david_100.png "David Pendray")
![Deepak1556](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Deepak1556/deepak_100.png "Deepak1556")
![Derek Wong](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Derek%20Wong/derek_100.png "Derek Wong")
![Dominik Kundel](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Dominik%20Kundel/dominik_k_100.png "Dominik Kundel")
![Glen De Cauwsemaecker](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Glen%20de%20Cauwsemaecker/glen_100.png "Glen De Cauwsemaecker")
![Ian Li](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Ian%20Li/ian_100.png "Ian Li")
![Jeremy Arns](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Jeremy%20Arns/jeremy_100.png "Jeremy Arns")
![Joachim Brehmer](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Joachim%20Brehmer/joachim_100.png "Joachim Brehmer")
![Jose Antonini](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Jose%20Antonini/jose_antonini_100.png "Jose Antonini")
![Katharine Chan](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Katharine%20Chan/katharine_100.png "Katharine Chan")
![Ken Stanley](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Ken%20Stanley/ken_100.png "Ken Stanley")
![Kevin Holland](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Kevin%20Holland/kevin_100.png "Kevin Holland")
![Laura Watiker](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Laura%20Watiker/laura_100.png "Laura Watiker")
![Michael Heasell](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Michael%20Heasell/michael_100.png "Michael Heasell")
![Michael Polyak](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Michael%20Polyak/michael_100.png "Michael Polyak")
![Mischa Lewis-Norelle](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Mischa%20Lewis-Norelle/mischa_100.png "Mischa Lewis-Norelle")
![Nathan Gosset](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Nathan%20Gosset/nathan_100.png "Nathan Gosset")
![Oleg Ulyanicky](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Oleg%20Ulyanickiy/oleg_100.png "Oleg Ulyanicky")
![Paul Buser](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Paul%20Buser/paul_100.png "Paul Buser")
![Pavel Konstantynov](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Pavel%20Konstantinov/pavel_100.png "Pavel Konstantynov")
![Popey Gilbert](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Popey%20Gilbert/popey_100.png "Popey Gilbert")
![Prabhsimran Baweja](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Prabhsimran%20Baweja/prabhsimran_100.png "Prabhsimran Baweja")
![Rachel Xiang](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Rachel%20Xiang/rachel_100.png "Rachel Xiang")
![Rebecca Saines](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Rebecca%20Saines/rebecca_100.png "Rebecca Saines")
![Robert Moreton](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Robert%20Moreton/robert_100.png "Robert Moreton")
![Ronnie Cheng](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Ronnie%20Cheng/ronnie_100.png "Ronnie Cheng")
![Ruben Vereecken](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Ruben%20Vereecken/ruben_100.png "Ruben Vereecken")
![Russ Fan](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Russ%20Fan/russ_100.png "Russ Fan")
![Shiying Zheng](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Shying%20Zheng/shiyeng_100.png "Shiying Zheng")
![Sébastien Moratinos](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Tom%20Steinbrecher/tom_100.png "Sébastien Moratinos")
![Thanish Muhammed](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Thanish%20Muhammed/thanish_100.png "Thanish Muhammed")
![Tom Steinbrecher](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Tom%20Steinbrecher/tom_100.png "Tom Steinbrecher")
![Yang Shun Tay](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Yang%20Shun%20Tay/yang_shun_tay_100.png "Yang Shun Tay")
![Zach Martin](https://dl.dropboxusercontent.com/u/138899/GitHub%20Wikis/avatars/Zach%20Martin/zack_100.png "Zach Martin")