Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 3.15 KB

README.md

File metadata and controls

63 lines (45 loc) · 3.15 KB
Raw

Ore

Build Status Ore Build Status Scalafmt

Repository software for Sponge plugins and Forge mods https://ore.spongepowered.org/

Ore is written in Scala using the Play framework.

Clone

The following steps will ensure your project is cloned properly.

  1. git clone https://github.com/SpongePowered/Ore.git
  2. cp scripts/pre-commit .git/hooks

Setup

After cloning Ore, the first thing you will want to do is create a new PostgreSQL 11 database for the application to use. This is required in order for Ore to run. Learn more about PostgreSQL here.

You will also need to enable a few extensions for Ore. These are:

In addition, you need to install Node.js and Yarn. Installation instructions are available for Node.js and Yarn.

After setting up a database, create a copy of application.conf.template named application.conf and configure the application, for the application you want to run. This file is in the .gitignore so it will not appear in your commits. Your local copy needs to get updated every time you pull changes, which add a new setting to the config. Currently valid applications are ore and jobs, and their configuration files can be found in ore/conf/application.conf.template and jobs/src/main/resources/application.conf.template.

In a typical development environment, most of the defaults are fine. Here are a few you might want to take a look at though.

For ore:

  • You can disable authentication by setting application.fakeUser to true.

Running

Running Ore is relatively simple.

With SBT

  • Download and install the latest SBT version.
  • Execute sbt ore/run in the project root to run the web app.
  • Execute sbt jobs/run in the project root to run the jobs processing.
  • Note: You are advised to keep the sbt shell open when doing development instead of starting it for each task.

With IntelliJ Community Edition

  • Install the Scala plugin.
  • Import the build.sbt file.

For ore:

  • Create a new SBT Task run configuration. Enter ore/run in the Tasks field.
  • Untick the box that says Use sbt shell
  • Run it.

For jobs:

  • Either repeat the process for ore, but use jobs/run instead of ore/run.
  • Or, click the green triangle next to OreJobProcessorMain when opening up the file.

Note: You might encounter a stack overflow exception when compiling ore. This is not unexpected. Just assign more stack size to sbt in the way you're starting sbt. -Xss4m should be enough. If you're using IntelliJ, you can set this in the VM arguments field. If you're invoking sbt directly, the most common ways to set this is either through the SBT_OPTS environment variable, or with a file named .jvmopts with each flag on a new line.