Modular, extensible, fast. https://engine.staropensource.de
Find a file
JeremyStarTM 2fedc981af
Some checks failed
build-and-test / generate-javadoc (push) Failing after 1m54s
build-and-test / build (push) Failing after 2m6s
build-and-test / test (push) Failing after 2m26s
Add shutdown hook functionality (broken, #6)
Doesn't really work right now, will likely be removed
2024-08-21 01:40:45 +02:00
.forgejo Add caching to workflows 2024-08-18 20:25:09 +02:00
.idea Sort and add new tasks 2024-07-11 04:15:37 +02:00
ansi Fix quirk of Jansi in AnsiShortcodeConverter 2024-08-19 20:14:55 +02:00
base Add shutdown hook functionality (broken, #6) 2024-08-21 01:40:45 +02:00
dist Add dist/ directory 2024-06-16 13:34:56 +02:00
docs Nuke 'graphics', welcome 'windowing' 2024-08-20 21:01:39 +02:00
gradle/wrapper Update Gradle wrapper to 8.10 2024-08-20 22:09:27 +02:00
slf4j-compat Remove unused and leftover methods 2024-08-19 02:49:31 +02:00
src/main/javadoc Update overview.html & add ANSI theme.css symlink 2024-08-01 03:01:37 +02:00
testapp Make GLFW subsystem standalone + remove unnecessary fluff 2024-08-20 22:07:49 +02:00
windowing Make GLFW subsystem standalone + remove unnecessary fluff 2024-08-20 22:07:49 +02:00
.gitattributes Add .gitattributes file for language detection 2024-08-18 12:39:16 +02:00
.gitignore Add 'run/' entry to gitignore 2024-07-16 14:53:17 +02:00
build.gradle Nuke 'graphics', welcome 'windowing' 2024-08-20 21:01:39 +02:00
COPYING Add classpath exception 2024-07-11 23:29:23 +02:00
gradle.properties [no ci] Sort properties in gradle.properties 2024-08-19 15:17:39 +02:00
gradlew Update to Gradle 8.9 2024-08-01 02:04:54 +02:00
gradlew.bat Update to Gradle 8.9 2024-08-01 02:04:54 +02:00
LICENSE Add classpath exception 2024-07-11 23:29:23 +02:00
README.md [no ci] Fix typos, add link for JVM langs 2024-08-20 20:54:02 +02:00
settings.gradle Nuke 'graphics', welcome 'windowing' 2024-08-20 21:01:39 +02:00

StarOpenSource Engine

The StarOpenSource Engine (or sos!engine for short) is a modular, extensible and easy to use Java game and application engine.

WARNING

The StarOpenSource Engine is under heavy development and is extremely unstable. Code will break often, prepare for potential major refactors when trying the engine out.

Index

About

... the engine

The StarOpenSource Engine is a modular and extensible framework for building applications and games written in one of the multiple JVM programming languages. The engine consists of various subsystems, each separate and responsible for only a few closely-related tasks.
Not only that. The engine also features various useful classes, interfaces and methods making development fun and simpler, while being lightweight.

... the repository

The sos!engine repository is a monorepo, consisting of the core engine, multiple official subsystems and their documentation.

Priorities

These are in no particular order.

  • configurable
  • do one thing and do it well (subsystems concept)
  • fast
  • few runtime dependencies (note: we will cut down on some of them during development)
  • modular & extensible
  • small & lightweight

Documentation

You can view the engine documentation at engine.staropensource.de. It provides information, guides and tutorials about the core engine and subsystems. If you want the API reference, you can visit the Javadoc for the engine and it's subsystems.

Contributing

Requirements

You need the following things to be able to contribute code to the StarOpenSource Engine:

  • knowledge of Java
  • knowledge about the internals of engine

What IDE to use?

We recommend and are using IntelliJ IDEA Community Edition for development because it is flexible, extendable, customizable, provides good completions and error detection. It's also open source.

Code style

We recommend looking at existing classes and code for a good understanding on how we'd like code to be written. Here's a quick rundown on the most important things:

  • Document EVERYTHING. Every single class, field and method, even if private.
  • Make comments about your code, unless it's extremely simple and easy to understand.
  • Make sure to add and update @since in javadoc comments (update if the javadoc changes a good amount).
  • Keep stuff simple, no need to elaborate what a logger is. Though remember to not make it too simple.
  • Make sure every field and method has a newline to separate it.
  • Files must end with a newline or cats might get angry.
  • Use your brain.

Pull request guidelines

Before creating a pull request, make sure you've:

  • created tests for the functionality you've added, changed or removed (if applicable),
  • tested your changes,
  • made sure that everything works,
  • is compatible with other code in the monorepo, and
  • is compatible with other applications. If not, tell us in your pull request description.

Making your first contribution

TODO