Code Monkey home page Code Monkey logo

granite's Introduction

Granite

Granite is the SpongeAPI implementation for Vanilla Minecraft.

  • IRC: #sponge or #spongedev on irc.esper.net

Prerequisites

Cloning

To clone Granite, simply run git clone [email protected]:SpongePowered/Granite.git

Setup

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

For Eclipse

  1. Run gradle setupDecompWorkspace --refresh-dependencies
  2. Make sure you have the Gradle plugin installed (Help > Eclipse Marketplace > Gradle Integration Plugin)
  3. Import Granite as a Gradle project (File > Import)
  4. Select the root folder for Granite and click Build Model
  5. Check Granite when it finishes building and click Finish

For IntelliJ

  1. Run gradle setupDecompWorkspace --refresh-dependencies
  2. Make sure you have the Gradle plugin enabled (File > Settings > Plugins).
  3. Click File > Import Module and select the build.gradle file for Granite.

Running

Note: The following is aimed to help you setup run configurations for Eclipse and IntelliJ, if you do not want to be able to run Granite directly from your IDE then you can skip this.

For Eclipse

  1. Go to Run > Run Configurations.
  2. Right-click Java Application and select New.
  3. Set the current project.
  4. Set the name as Granite (Client) and apply the information for Client below.
  5. Repeat step 1 through 4, then set the name as Granite (Server) and apply the information for Server below.
  6. When launching the server for the first time, it will shutdown by itself. You will need to modify the server.properties to set onlinemode=false and modify the eula.txt to set eula=true (this means you agree to the Mojang EULA, if you do not wish to do this then you cannot run the server).

For IntelliJ

  1. Go to Run > Edit Configurations.
  2. Click the green + button and select Application.
  3. Set the name as Granite (Client) and apply the information for Client below.
  4. Repeat step 2 and set the name as Granite (Server) and apply the information for Server below.
  5. When launching the server for the first time, it will shutdown by itself. You will need to modify the server.properties to set onlinemode=false and modify the eula.txt to set eula=true (this means you agree to the Mojang EULA, if you do not wish to do this then you cannot run the server).

Client

Property Value
Main class GradleStart
Program arguments --noCoreSearch
Working directory ./run (Included in project)
Module classpath Granite (IntelliJ Only)

Server

Property Value
Main class GradleStartServer
Program arguments --noCoreSearch
Working directory ./run (Included in project)
Module classpath Granite (IntelliJ Only)

Building

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

In order to build Granite you simply need to run the gradle command. You can find the compiled JAR files in ./build/libs but in most cases you'll only need 'granite-x.x.x-x.x.x.jar'.

FAQ

A dependency was added, but my IDE is missing it! How do I add it?

If a new dependency was added, you can just restart your IDE and the Gradle plugin for that IDE should pull in the new dependencies.

Help! Things are not working!

Some issues can be resolved by deleting the '.gradle' folder in your user directory and running through the setup steps again, or even running gradle cleanCache and running through the setup again. Otherwise if you are having trouble with something that the README does not cover, feel free to join our IRC channel and ask for assistance.

granite's People

Contributors

aphadeon avatar ccourson avatar gynter avatar hidendra avatar jamierocks avatar jckf avatar lynkgx avatar miraclem4n avatar myrninvollo avatar n0odlez avatar oloflarsson avatar robobenklein avatar rustywolf avatar stephan-gh avatar tritania avatar xske avatar

Watchers

 avatar

Forkers

xske

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.