This repository has been archived by the owner. It is now read-only.
A CanaryLib implementation for Minecraft Forge.
Switch branches/tags
Nothing to show
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 @ 2d58d84
gradle/wrapper
src/main
.gitignore
.gitmodules
LICENSE
README.md
build.gradle
gradle.properties
gradlew
gradlew.bat
settings.gradle

README.md

NeptuneForge

Currently not stable and under heavy development!
A Forge implementation of CanaryLib, licensed under the MIT License.

Prerequisites

Clone

The following steps will ensure your project is cloned properly.

  1. git clone --recursive https://github.com/NeptunePowered/NeptuneForge.git
  2. cd NeptuneForge

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. Run gradle eclipse
  3. Import NeptuneForge as an existing project (File > Import > General)
  4. Select the root folder for NeptuneForge and make sure Search for nested projects is enabled
  5. Check NeptuneForge 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 > New > Project from Existing Sources > Gradle and select the root folder for NeptuneForge.

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 NeptuneForge 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 NeptuneForge (Client) and apply the information for Client below.
  5. Repeat step 1 through 4, then set the name as NeptuneForge (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 NeptuneForge (Client) and apply the information for Client below.
  4. Repeat step 2 and set the name as NeptuneForge (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
VM options -Dfml.coreMods.load=org.neptunepowered.forge.ForgeCoremod
Working directory ./run/client
Module classpath NeptuneForge (IntelliJ Only)

Server

Property Value
Main class GradleStartServer
VM Options -Dfml.coreMods.load=org.neptunepowered.forge.ForgeCoremod
Working directory ./run/server
Module classpath NeptuneForge (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 NeptuneForge you simply need to run the gradle command. You can find the compiled JAR file in ./build/libs labeled similarly to 'neptuneforge-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.