NeonTea/Cyber
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
excitedneon 2017-05-13 17:38:59 +03:00
parent c338cd85e5
commit 5eb424bea0
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -2,6 +2,16 @@ Cyber
=====
A cyberpunk roleplaying game with online connectivity, made in Unity3D.
How to play
-----------
Currently there are no binary releases, so you're going to have to set up a dev environment to play the game.
1. Install [Unity](https://unity3d.com/).
2. Clone this repo. `git clone https://github.com/Saltosion/Cyber`
3. Download the assets from the [Dependencies](#dependencies) list, and put them in /path/to/Cyber/Assets/AssetStoreTools.
4. Launch Unity, open this repo's directory as a project.
5. In Unity, go to File -> Build Settings -> Build (remember to choose your platform from the list).
6. Play the game you just built! Note: You'll need to run the game two times, one for the server, one for the client. On the server, run `host` in the in-game console, on the client, run `join`. You can toggle the in-game console with the Tab key.
Roadmap
-------
See [the roadmap](ROADMAP.md).
@ -10,8 +20,8 @@ Design
------
See [game design document](GDD.md).
Unity Dependencies
------------------
Dependencies
------------
Before doing anything in Unity, install these into the /Assets/AssetStoreTools directory. Note that it's in the gitignore, so you need to create the directory yourself.
- [Post Processing Stack](https://www.assetstore.unity3d.com/en/#!/content/83912)