/pebbles-engine

Pebbles Virtual Novel Engine

Primary LanguageKotlinMozilla Public License 2.0MPL-2.0

Pebbles Engine

Pebbles is my Virtual Novel game engine, written in Kotlin. It's named after my cat, Pebbles.

This is the Wriggle Nightbug (0.8) branch, which contains significant rewrites over the old engine including a better renderer, music, better font generation, and so on.

Usage

Add my maven:

repositories {
    mavenCentral()

    maven(url="https://maven.veriny.tf/releases")
}

Then add the library to your project:

dependencies {
    implementation("tf.veriny.pebbles:pebbles-engine:0.8.x")
}

Create an instance of SS76Settings, and use SS76.start to run your game:

public object MakeUp {

    @JvmStatic
    public fun main(args: Array<String>) {
        val settings = SS76Settings(
            namespace = "my-project-namespace",
            initialiser = ::setupEngine,
            isDebugMode = !isInsideJar(MakeUp::class)
        )
        SS76.start(settings)
    }

    public fun setupEngine(state: EngineState) {
        // do things here
    }
}

All code is under the tf.veriny.ss76.engine package. It's named that because this was originally the VN engine in use for an old project that I extracted the code out of.