Skip to content
Repository for Crystal Home Systems
Java Python
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Common
Heart
Shard
docs
gradle/wrapper
.gitattributes
.gitignore
.travis.yml
HeartVersion
LICENSE
README.md
ShardVersion
build.gradle
gradlew
gradlew.bat
settings.gradle

README.md

Build Status

alt tag

Crystal Home Systems

Copyright© 2015 Austin VanAlstyne, Bailey Thorson

Using Crystal

Crystal comes in two parts. The Heart (or main server), and the Shard (or client). The Heart requires a Window's machine for now, and network access. The Shard can be run on any machine and needs network access as well.

After you have downloaded the seperate parts as zip files, extract the folders into their respective locations (it does not matter where). Inside of each directory there is a bin folder. To run the respective software, run either the .bat file or the shell file, depending on what OS you are using. Crystal does NOT require administrator permissions.

From there the software will walk you through the quick setup steps, and you are ready to go!

Building Crystal

Crystal is built with a Gradle wrapper. After cloning or downloading the repository, navigate to the root folder and open your command line. Execute gradlew build. The build automatically copies the compiled zip files into the .distributions folder in the root directory. To run, simply unzip the folder(s) and execute the jar files.

Wiki*

Look at the wiki for features, usage, and extending Crystal to fit your needs.*

License

This file is part of Crystal Home Systems.

Crystal Home Systems is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Crystal Home Systems is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with Crystal Home Systems. If not, see http://www.gnu.org/licenses/.

Footer - * coming soon

You can’t perform that action at this time.