https://github.com/willowtreeapps/wombats-documentation

Wombat's API Documentation
https://github.com/willowtreeapps/wombats-documentation

wombats

Last synced: 11 months ago
JSON representation

Wombat's API Documentation

• Host: GitHub
• URL: https://github.com/willowtreeapps/wombats-documentation
• Owner: willowtreeapps
• License: mit
• Created: 2017-02-08T21:01:04.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-04-04T23:12:55.000Z (about 9 years ago)
• Last Synced: 2025-07-15T12:03:56.151Z (12 months ago)
• Topics: wombats
• Language: JavaScript
• Size: 1.21 MB
• Stars: 1
• Watchers: 18
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: code-of-conduct.md

Awesome Lists containing this project

README

          
# Wombats Documentation 

This repository provides documentation for all Wombat repos including [Wombats API](https://github.com/willowtreeapps/wombats-api), [Wombats Web Client](https://github.com/willowtreeapps/wombats-web-client), [Wombat Bots](https://github.com/willowtreeapps/wombats-bots), and [Wombat Lamba](https://github.com/willowtreeapps/wombats-lambda).

## What is Wombats?

Wombats is an interactive game to learn about coding and AI strategy. Create a wombat (bot), join a game, and watch your Clojure code play out in an arena against your fellow competitors!

We hope that with this game, users will hone their Clojure skills and gain exposure to Open Source projects (and contribute!). 

## How to play

* Review [Gameplay](https://github.com/willowtreeapps/wombats-documentation/wiki/Gameplay)

* Go to our [Wombat Bots](https://github.com/willowtreeapps/wombats-bots) repo and fork to your personal repo.

* Navigate to [wombats.io](http://qa.wombats.io/#/) 

* Click Login

* Give our github access to your github account

* Go to My Wombats

* Click the + button in the bottom righthand corner

* Write a wombat name

* Wombat URL format: `/wombats-bots/contents/wombat-sample.clj`

* Go to Games

* Hover over open game

* Click Join

* Enter password if applicable, choose the wombat you just created, select a color and then join!

* Click the game card that you just joined to navigate to that game.

* Enjoy!

## How to Develop

Look at individual repos (above) for how to get started deving for that repo! 

## Project Diagrams 

### Architecture Diagram

![](https://github.com/willowtreeapps/wombats-documentation/blob/master/diagrams/architecture.png)

### Authentication Diagram

![](https://github.com/willowtreeapps/wombats-documentation/blob/master/diagrams/authentication.png)

### Game Processing Diagram

![](https://github.com/willowtreeapps/wombats-documentation/blob/master/diagrams/game_processing.png)

## How to Contribute

Look at our [Contributing Documentation](https://github.com/willowtreeapps/wombats-documentation/blob/master/CONTRIBUTING.md) and check out our [Waffle](https://waffle.io/willowtreeapps/wombats-api/join) for open tickets.