JeremyStarTM/Engine
1
0
Fork 0
forked from StarOpenSource/Engine
Code Pull requests Activity Actions
A modular, extensible and easy to use Java game and application engine.
76 commits 4 branches 4 tags 13 MiB
Java 100%
Find a file
JeremyStarTM 832ed5cd5c
Rename RELEASECANDIDATE to RELEASE_CANDIDATE
2024-06-11 22:29:41 +02:00
.idea Add "Run tests" task to IntelliJ IDEA 2024-06-09 13:41:44 +02:00
base Rename RELEASECANDIDATE to RELEASE_CANDIDATE 2024-06-11 22:29:41 +02:00
gradle/wrapper Initial commit 2024-06-08 15:33:03 +02:00
slf4j-compat Add package-info to SLF4J Compatibility Logger 2024-06-11 22:28:26 +02:00
src/main/javadoc Add combined javadoc for all subprojects 2024-06-08 17:10:00 +02:00
testapp Add SLF4J Compatibility subsystem 2024-06-11 20:01:34 +02:00
.gitignore Add all .idea files to .gitignore 2024-06-08 15:36:08 +02:00
build.gradle Rename dependencies 2024-06-09 16:31:11 +02:00
gradle.properties Add SLF4J Compatibility subsystem 2024-06-11 20:01:34 +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 Initial commit 2024-06-08 15:33:03 +02:00
settings.gradle Add SLF4J Compatibility subsystem 2024-06-11 20:01:34 +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.

Index

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, while being lightweight.

About the repository

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

Priorities

Documentation

The official documentation for the StarOpenSource Engine is not yet available and won't be until we hit v1-rc0. You can however visit the Javadocs.

Contributing

Requirements

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

  • knowledge of Java
  • (basic) knowledge of the 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-rc0