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:
After setting up a database, create a copy of
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
jobs, and their configuration files can be found in
In a typical development environment, most of the defaults are fine. Here are a few you might want to take a look at though.
- You can disable authentication by setting
Running Ore is relatively simple.
- Download and install the latest SBT version.
sbt ore/runin the project root to run the web app.
sbt jobs/runin 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
- Create a new SBT Task run configuration. Enter
ore/runin the Tasks field.
- Untick the box that says
Use sbt shell
- Run it.
- Either repeat the process for
ore, but use
- Or, click the green triangle next to
OreJobProcessorMainwhen 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
SBT_OPTS environment variable, or with a file named
.jvmopts with each flag on a new line.