Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Added general information about the project and the game directed at new visitors.
  • Loading branch information
Phrancis committed Feb 3, 2015
1 parent 7eb4d45 commit 92f6f16
Showing 1 changed file with 31 additions and 7 deletions.
38 changes: 31 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,46 @@ Cardshifter

_Updated 2015-02-03_

Master branch: [![Build Status](https://travis-ci.org/Cardshifter/Cardshifter.svg?branch=master)](https://travis-ci.org/Cardshifter/Cardshifter?branch=master)
Develop branch: [![Build Status](https://travis-ci.org/Cardshifter/Cardshifter.svg?branch=develop)](https://travis-ci.org/Cardshifter/Cardshifter?branch=develop)
####What is Cardshifter?
------------------------

Cardshifter is an open-source, online Trading Card Game (TCG). The idea was born in summer of 2014 when a handful of software developers and programming enthusiasts from [Code Review Stack Exchange](http://codereview.stackexchange.com/) were tossing ideas around on how to come up with an innovative and fun game using the latest Java 8 technologies.

The game is cross-platform compatible (Windows, OS X, Linux) and eventually will feature mobile versions as well. It is early in development, but we are working hard on adding new gameplay features, improving the user interface, and will eventually feature original art from content creators who have since joined the project.

####How can I get involved?
---------------------------

If you are interested in helping with the project, there are a number of ways you can go about it:

- Open a [Github Issue](https://github.com/Cardshifter/Cardshifter/issues).

- Find an issue you would like to work on a create a pull request or branch. Issues tagged "Help Wanted" are particularly good for new contributors to work on.

- Join the [chatroom](http://chat.stackexchange.com/rooms/16134/tcg-creation) on Stack Exchange and discuss how you can contribute. _Please note that a minimum of 20 reputation on any Stack Exchange site (including Stack Overflow) is required before you can post in chat._

If you are not a developer, you can also help by playing the game and [reporting any bug](https://www.Cardshifter.com/report-bug.html) you find or [requesting new features](https://www.Cardshifter.com/request-feature.html) you'd like to see added to the game. See the instructions below.

####Playing the game
--------------------

To play the game, [download the latest release](https://github.com/Cardshifter/Cardshifter/releases). Start the client jar using `java -jar cardshifter-fx-<version>.jar` or by saving to your computer and simply double-clicking `cardshifter-fx-<version>.jar`. There is a server running at `dwarftowers.com` port `4242` that you may connect to and play with other players as well as AI players.


####Useful links
----------------

- Master branch: [![Build Status](https://travis-ci.org/Cardshifter/Cardshifter.svg?branch=master)](https://travis-ci.org/Cardshifter/Cardshifter?branch=master)

- Develop branch: [![Build Status](https://travis-ci.org/Cardshifter/Cardshifter.svg?branch=develop)](https://travis-ci.org/Cardshifter/Cardshifter?branch=develop)

- [Developer guidelines](https://github.com/Cardshifter/Cardshifter/wiki/Developer-Guidelines)

- [Releases & Features](https://github.com/Cardshifter/Cardshifter/wiki/Releases-&-Features)

- [Official Website](http://www.Cardshifter.com/)

- [Official Website](https://www.Cardshifter.com/)

Playing the game
----------------

To play the game, [download the latest release](https://github.com/Cardshifter/Cardshifter/releases). Start the client jar using `java -jar cardshifter-fx-<version>.jar` or by saving to your computer and simply double-clicking `cardshifter-fx-<version>.jar`. There is a server running at `dwarftowers.com` port `4242` that you may connect to and play with other players as well as AI players.



Expand Down

0 comments on commit 92f6f16

Please sign in to comment.