Skip to content

nailed/nailed-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

36 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Nailed API

The API for Nailed, the pvp game server framework. It is licensed under the MIT License.

Prerequisites

Clone

The following steps will ensure your project is cloned properly.

  1. git clone git@github.com:nailed/nailed.git
  2. cd nailed

Setup

Note: If you do not have Gradle installed then use ./gradlew for Unix systems or Git Bash and gradlew.bat for Windows systems instead of any 'gradle' command.

For IntelliJ
2. Run gradle idea
3. Open the generated nailed.ipr file in IntelliJ
4. When IntelliJ asks you to import the gradle project, click on Import gradle project

For Eclipse

  • Currently we do not support Eclipse. IntelliJ is our only supported IDE

Building

Note: If you do not have Gradle installed then use ./gradlew for Unix systems or Git Bash and gradlew.bat for Windows systems instead of any 'gradle' command.

In order to build Nailed API you simply need to run the gradle build command. You can find the compiled JAR files in ./build/libs labeled similarly to 'nailed-api-x.x.x-SNAPSHOT.jar'.

Contributing

Are you a talented programmer looking to contribute some code? We'd love the help!

  • Open a pull request with your changes, following our guidelines.
  • Please follow the above guidelines for your pull request(s) to be accepted.