Repository software for Sponge plugins and Forge mods https://ore.spongepowered.org/
Ore is written in Scala using the Play framework.
The following steps will ensure your project is cloned properly.
git clone https://github.com/SpongePowered/Ore.git
cp scripts/pre-commit .git/hooks
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
:
application.fakeUser
to true
.Running Ore is relatively simple.
With SBT
sbt ore/run
in the project root to run the web app.sbt jobs/run
in the project root to run the jobs processing.With IntelliJ Community Edition
build.sbt
file.For ore
:
ore/run
in the Tasks field.Use sbt shell
For jobs
:
ore
, but use jobs/run
instead of ore/run
.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.