A modular, extensible and easy to use Java game and application engine.

Find a file

JeremyStarTM 7c553c24f0 Move data types and classes around		2024-07-11 14:38:00 +02:00
.idea	Sort and add new tasks	2024-07-11 04:15:37 +02:00
base	Move data types and classes around	2024-07-11 14:38:00 +02:00
dist	Add dist/ directory	2024-06-16 13:34:56 +02:00
docs	Add documentation	2024-06-16 15:52:33 +02:00
gradle/wrapper	Initial commit	2024-06-08 15:33:03 +02:00
graphics	Move data types and classes around	2024-07-11 14:38:00 +02:00
slf4j-compat	Move data types and classes around	2024-07-11 14:38:00 +02:00
src/main/javadoc	Update Javadoc theme	2024-07-11 05:00:09 +02:00
testapp	Move data types and classes around	2024-07-11 14:38:00 +02:00
.gitignore	Add dist/ directory	2024-06-16 13:34:56 +02:00
build.gradle	Add comments and fix Javadoc generation	2024-07-11 04:03:08 +02:00
gradle.properties	Oh god	2024-07-08 19:04:57 +02:00
gradlew	Initial commit	2024-06-08 15:33:03 +02:00
gradlew.bat	Initial commit	2024-06-08 15:33:03 +02:00
LICENSE	Initial commit	2024-06-08 15:33:03 +02:00
README.md	Add READMEs to all subsystems	2024-06-27 20:25:32 +02:00
settings.gradle	Plaster copyright notice over everything	2024-06-28 01:08:45 +02:00

README.md

StarOpenSource Engine

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

About

About the engine

The sos!engine is a modular and extensible framework for building applications and games, written in the Java programming language. The engine consists of various subsystems, each separate and responsible for only one thing. The engine also houses various useful utilities and classes making development fun, and all that while being lightweight.

About the repository

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

Priorities

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

Documentation

The official documentation for the StarOpenSource Engine is not yet available, but is planned. You can however visit the Javadocs.

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 use and recommend 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.

Read this before creating a pull request

Before creating a pull request, make sure you've

created tests for the functionality you 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 (probably) until v1-alpha0