https://github.com/fuyukai/pebbles-engine

Pebbles Virtual Novel Engine
https://github.com/fuyukai/pebbles-engine

kotlin libgdx visual-novel

Last synced: 23 days ago
JSON representation

Pebbles Virtual Novel Engine

• Host: GitHub
• URL: https://github.com/fuyukai/pebbles-engine
• Owner: Fuyukai
• License: mpl-2.0
• Created: 2021-11-16T21:08:39.000Z (almost 3 years ago)
• Default Branch: wriggle-nightbug
• Last Pushed: 2023-10-29T15:29:06.000Z (about 1 year ago)
• Last Synced: 2024-06-28T03:36:44.030Z (4 months ago)
• Topics: kotlin, libgdx, visual-novel
• Language: Kotlin
• Homepage:
• Size: 2.06 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
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:

.. code-block:: kotlin

    repositories {

        mavenCentral()

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

    }

Then add the library to your project:

.. code-block:: kotlin

    dependencies {

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

    }

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

.. code-block:: kotlin

    public object MakeUp {

        @JvmStatic

        public fun main(args: Array) {

            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.