https://github.com/minecraftforge/scorge

Scala Language Adapter for Forge Mods
https://github.com/minecraftforge/scorge

forge language-adapter minecraft minecraftforge mod modding scala

Last synced: 4 days ago
JSON representation

Scala Language Adapter for Forge Mods

• Host: GitHub
• URL: https://github.com/minecraftforge/scorge
• Owner: MinecraftForge
• License: lgpl-2.1
• Archived: true
• Created: 2017-11-08T02:46:09.000Z (about 7 years ago)
• Default Branch: 1.19.x
• Last Pushed: 2023-09-16T23:56:39.000Z (over 1 year ago)
• Last Synced: 2024-09-27T11:06:18.857Z (4 months ago)
• Topics: forge, language-adapter, minecraft, minecraftforge, mod, modding, scala
• Language: Scala
• Size: 184 KB
• Stars: 29
• Watchers: 9
• Forks: 16
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Archived 

Archived until futher notice, Scala can be a useful lanuage, but the cost of distributing the scala runtime files has been a major burden on Forge for a long time. Tho I have no intention of removing those files from our servers so that legacy versions can still be used. I also do not have any intentions of ever updating this to newer minecraft versions. Also this hasn't even been updated to 1.20. There are other projects out there that add updated scala as a Forge language loader. Use any of them.

---

# Scorge

A Forge language loader the [Scala](https://www.scala-lang.org/) programming language

## Supported Scala version

Current Supported version is 3.2.1

## Shaded libraries

Scorge currently includes

* scala3-library_3

* scala-library

## Scala Version Policy

Scorge will only support the latest major release of Scala starting once Forge is stabilized for a release. It will lock Scala version till its next stable release. Scorge will __not__ support release candidates or milestone versions of Scala. 

## Scorge library policy

If you want to add a new library for Scorge to support.

1. It must be made for Scala

2. You must have a good technical reason as to why it would be better supported in Scorge instead of being shipped with your mod.

If you want to drop a library supported by Scorge

1. It must be done during a version switch of minecraft to not break backwards compatibility within an MC version

2. You must have a good technical reason as to why it should be dropped

## Usage

(You can find a complete example setup in the [example](example) directory.) 

To use Scorge in your project, simply add it to your gradle dependencies.

Scorge will automatically add the necessary scala libraries to your compile classpath.

```gradle

dependencies {

    implementation 'net.minecraftforge:Scorge:VERSION'

}

```

Next, modify your `mods.toml` to use the `scorge` loader.

Additionally, each declared mod also needs to have an `entryClass` attribute that points to the

mod's scala class.

```toml

modLoader="scorge"

loaderVersion="[4,)"

[[mods]]

    entryClass="com.example.mod.ExampleScalaMod"

```