This is a skeleton project for Zircon users that can be used to get started with Zircon.

Overview

Zircon Kotlin Skeleton Project

This is a skeleton project for Zircon users that can be used to get started with Zircon.

Getting started

This project works on all platforms but there are some prerequisites that must be installed before you can start coding.

  1. Git. (optional) Git is a version control system. If you use GitHub you are already familiar with it. You don't need extensive Git knowledge to work with this project, but you need to install Git on your system if you want to clone / fork this project. You can get it here. Alternatively you can download the zip / tarball from the Releases page.
  2. Java This project uses Kotlin, so you must install a Java JDK to get started. We suggest OpenJDK but any other JDK will do. Java 8 or above is recommended.

That's all!

Setting up

In order to set up a local dev environment on your computer you need to follow these steps:

Check the project out. (optional)

If you want to use Git to clone the project you need to navigate to a folder where you want to check the project out in a terminal and type the following command:

git clone https://github.com/Hexworks/zircon.skeleton.kotlin.git

Alternatively you can just download and extract the latest release form the Releases page.

Import the project to your IDE.

It is highly recommended to use IntelliJ IDEA for this project. You can get the free community version from this page. You don't need to buy the Ultimate version, the Community Edition is perfectly fine.

Importing the project is pretty simple. When IDEA is started you need to

  1. Click Import Project
  2. Select the directory where your project resides (the project directory itself)
  3. In the following dialog select Gradle: import
  4. Then select "Use auto import" and also a JDK as seen here: settings Note that you'll need to tell IDEA about where your JDK is because it will probably not detect your installation. More info about getting started with IDEA can be found here
  5. You are ready to go!

Notes about Gradle

This project uses the Gradle build tool. You don't need to be a Gradle expert to get started with the project. Gradle is bundled to this project and can be invoked by running the gradlew script.

For Windows users it is recommended to use Git Bash to run it.

This means that you don't need to install anything, everything is in place to get you started.

In order to build your project you'll need to run the following command in your project directory:

./gradlew clean build

If you get a permission denied error you'll need to add execution permissions to gradlew this way: chmod +x gradlew

Running this command will create an artifact in the build/libs directory which contains a Main class so you can run your project right away by typing this command:

java -jar build/libs/zircon.skeleton.kotlin-1.2.0-all.jar

You'll be presented by a new window with a greeting:

Greeting

Congratulations! You just run your first Zircon program!

Development resources

  • To get started with Zircon you can check the Zircon Project Page on our website here
  • If you get stuck with Zircon feel free to come up to our Discord channel where you can ask us and other Zircon users
  • The Roguelikedev Subreddit is also a good source of information
  • To learn about Gradle check out their official documentation page here
  • If you want to get acquainted with the testing tools used in this project check out the docs of AssertJ
  • If nothing helps or if you think that there is a bug in this project feel free to open a new issue here.

Credits

The "tetris" tileset was contributed by CO (Thanks!)

You might also like...
This prototype app provides a list of events to be held under an organization (school, college, club, etc.) and the users can manually set event reminders at their scheduled time so that they do not miss an event.

E-CELL NITS Sample App This prototype app provides a list of events to be held under E-Cell NIT Silchar (for example, Srijan 2.0) and the users can ma

Team management service is a production ready and fully tested service that can be used as a template for a microservices development.
Team management service is a production ready and fully tested service that can be used as a template for a microservices development.

team-mgmt-service Description Team management service is a production ready and fully tested service that can be used as a template for a microservice

An open source app which can be used to do basic surveys
An open source app which can be used to do basic surveys

SurveyApp This is an open source app which can be used to do basic surveys. It supports multiple question types. For demo please check the releases pa

Tweaks - A customizable debug screen to view and edit flags that can be used for development
Tweaks - A customizable debug screen to view and edit flags that can be used for development

A customizable debug screen to view and edit flags that can be used for developm

Tool for exporting Old School RuneScape environments so they can be used in 3D modeling programs like Blender.

OSRS Environment Exporter Tool for exporting Old School RuneScape environments so that they can be used in 3D modeling programs like Blender. Download

A library that extends the existing JDBC API so that data objects can be used as input (to set parameters) and output (from ResultSet's rows).

SqlObjectMapper This is a library that extends the existing JDBC API so that data objects can be used as input (to set parameters) and output (from Re

sample project that shows you how you can use Ktor to creat a server for real Project.

Ktor-Sample This is a sample project that shows you how you can use Ktor to creat a server for real Project. What is done Save data to database (Get a

QrPay - This section should list any major frameworks/libraries used to bootstrap your project
QrPay - This section should list any major frameworks/libraries used to bootstrap your project

View Demo · Report Bug · Request Feature About The Project Very simple You register, the system generates a unique ID You login with your unique

This Kotlin Multiplatform library is for accessing the TMDB API to get movie and TV show content. Using for Android, iOS, and JS projects.

Website | Forum | Documentation | TMDb 3 API Get movie and TV show content from TMDb in a fast and simple way. TMDb API This library gives access to T

Owner
Vladislav Kashchey
JB MSE student
Vladislav Kashchey
A sample skeleton backend app built using Spring Boot kotlin, Expedia Kotlin Graphql, Reactive Web that can be deployed to Google App Engine Flexible environmennt

spring-kotlin-gql-gae This is a sample skeleton of a backend app that was built using: Spring Boot(Kotlin) Reactive Web Sprinng Data R2DBC with MYSQL

Dario Mungoi 7 Sep 17, 2022
Getting Started with the URL Shortener project

Getting Started with the URL Shortener project Overall structure The structure of this project is heavily influenced by the clean architecture: A core

null 0 Nov 8, 2021
Add page & limit as GET parameter to get all titans data in a paginated format

Add page & limit as GET parameter to get all titans data in a paginated format (default values : page=1 and limit=3). Here the page param is the page number which you require and limit is the maximum number of items per page. Sample Request :

krishna chaitanya 1 Jan 31, 2022
Github User App for searching Github Users and get several information from it.

GithubUserApp Github User App for searching Github Users and get several information from it. This code implement with Coroutines, Retrofit, Architect

Wahyu Hendiarto W. 0 Apr 16, 2022
NPS android library to get the feedback you need from users

netpromoterscore NPS android library helps you to get the feedback you need from the users Gradle Dependency: implementation 'com.github.quantumlibs:n

Nithin Naubad 1 May 12, 2022
Examples of Getting Started vídeos

Getting Started Kotlin Learn the basics of getting started with kotlin --->>> Repo: Kotlin Koans <<<--- --->>> Repo: Problems Kotlin <<<--- --->>> Rep

Victor Bolinches 41 Dec 4, 2022
Spring-graphql-getting-started - Spring for GraphQL provides support for Spring applications built on GraphQL Java

Getting Started with GraphQL and Spring Boot Spring for GraphQL provides support

Shinya 0 Feb 2, 2022
Getting started Kotlin - Examples and explanations

Getting started Kotlin I'm learning Kotlin, so I have been updating it with examples and explanations about the language that I'm using at work. Proje

Jean Jacques Nascimento Barros 2 Apr 25, 2022
A simple tool used to check the users you follow that do not follow you back.

instafbchecker - Instagram no life guide Current Release: v1.0.1 (30/08/2022) A command line tool used to check which users dont follow you back on In

Nathan 2 Aug 30, 2022