Skip to content
This repository has been archived by the owner on Feb 26, 2019. It is now read-only.

Latest commit

 

History

History
67 lines (40 loc) · 2.81 KB

README.md

File metadata and controls

67 lines (40 loc) · 2.81 KB
Raw

coUclient

Children of Ur's Dart-based browser client

This repository contains the source code for Children of Ur's Dart-based browser client.

Codeship Status for ChildrenOfUr/coUclient

License

Children of Ur is based on Tiny Speck's browser-based game, Glitch™. The original game's elements have been released into the public domain. For more information on the original game and its licensing information, visit glitchthegame.com.

License information for other assets used in Children of Ur can be found in ATTRIBUTION.md.

Usage

The code is live at childrenofur.com.

If you want to run it locally or on your own server, you'll need to have an environment with Dart installed. Note that this repository does not currently contain any prebuilt files, so you'll also need a development environment. See Contributing below.

Contributing

coUclient is based on Dart, so the first thing you'll need to do (if you haven't already) is to install it.

Setting up a development environment

  1. Install the Dart SDK for your platform. Make sure you have at least version 2.0.0.
  2. Make sure the SDK and your pub cache are on your path. On Linux, add this line to the end of your ~/.bashrc: `export PATH=$PATH:"/usr/lib/dart/bin":"$HOME/.pub-cache/bin"
  3. Install webdev: pub global activate webdev
  4. Generate precompiled files: webdev build

If you'd prefer an IDE

See https://www.dartlang.org/tools.

Other platforms and/or manual installation

For instructions on manually installing Dart as well as links to other platforms, see https://www.dartlang.org/install .

Building

Command line

  1. pub get
  2. webdev build

Running locally

The client uses the contents of web/server_domain.txt to find the server. If you're running the server locally, it should contain localhost. For the values to use if you want to connect to the dev or live servers, please contact someone on the development team.

  1. webdev serve

General Roadmap

The project is built in Dart, which is then compiled and minified into javascript and can run in most browsers. See our team collaboration site on Trello for the current roadmap.

Project Layout

  • main.dart serves as the main game loop. This class controls all functions within the game.
  • Dart classes and functions are in the lib/src folder.
  • Images, CSS and other web resources are in web/assets.
  • More development documentation is in the doc folder.