Skip to content

Latest commit

 

History

History
109 lines (84 loc) · 6.01 KB

README.md

File metadata and controls

109 lines (84 loc) · 6.01 KB
Raw

Obsidian Build Status Coverage Status

Obsidian is a framework that extends Forge to deliver server-side content on demand. It is licensed under the MIT License

Prerequisites

Cloning

If you are using Git, use this command to clone the project: git clone [email protected]:ObsidianBox/Obsidian.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 Obsidian as a Gradle project (File > Import)
  4. Select the root folder for Obsidian and click Build Model
  5. Check Obsidian 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 Obsidian.

Running

Note 1: The following is aimed to help you setup run configurations for Eclipse and IntelliJ, if you do not want to be able to run Obsidian directly from your IDE then you can skip this. Note 2: When running the Server, make sure you set it to online-mode=false in the server.properties in ~/run/server!

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 Obsidian (Client) and apply the information for Client below.
  5. Repeat step 1 through 4, then set the name as Obsidian (Server) and apply the information for Server below.

For IntelliJ

  1. Go to Run > Edit Configurations.
  2. Click the green + button and select Application.
  3. Set the name as Obsidian (Client) and apply the information for Client below.
  4. Repeat step 2 and set the name as Obsidian (Server) and apply the information for Server below.
    4a. 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 -Djava.library.path="../../build/natives"
Working directory ~/run/client (Included in project)
Module classpath Obsidian (IntelliJ Only)

Server

Property Value
Main class GradleStartServer
Working directory ~/run/server (Included in project)
Module classpath Obsidian (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 Obsidian you simply need to run the gradle command. You can find the compiled JAR files in ~/build/distributions but in most cases you'll only need 'obsidian-x.x.x-SNAPSHOT.jar'.

If you are making changes with Magma then build Magma first, then Obsidian.

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 and coding standards.
  • Please follow the above guidelines and requirements for your pull request(s) to be accepted.

Love the project? Feel free to donate to help continue development! Obsidian is open-source and powered by community members, like yourself. Without you, we wouldn't be here today!

FAQ

Why do I get javac: source release 1.7 requires target release 1.7 in IntelliJ when running the client configuration?

Sometimes another project can mess with the settings in IntelliJ. Fixing this is relatively easy.

  1. Go to 'File > Settings'.
  2. Click the drop down for 'Compiler' on the left-hand side and select 'Java Compiler'.
  3. Select Obsidian and set the 'Target bytecode version' as '1.7'.
  4. Click Apply and OK and try running it again.

Why do I get Zip file rt.jar failed to read properly in IntelliJ?

This is the result of Forge attempting to classload the Java runtime JAR, overall it is not an error that will cause any harm to your development and should be ignored.

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.