README.md

ScrewBox is a minimalist pure Java game engine. If you want to start building your own 2D game without leaving your cozy IDE it might be a fun choice.

Introduction

ScrewBox uses a purely code based approach on creating games to not force you into using a proprietary content editor. As an open-source project, ScrewBox encourages collaboration and feedback. You can use it as-is, modify it or contribute to its development.

Learn more about the ScrewBox game engine at screwbox.dev.

Getting Started

Getting started with ScrewBox isn't that hard. Learn more in this Getting Started Guide.

public static void main(String[] args) {
  Engine screwBox = ScrewBox.createEngine("Hello World");

  screwBox.environment()
    .enableAllFeatures()
    .addEntity(new Entity()
      .add(new CursorAttachmentComponent())
      .add(new RenderComponent(SpriteBundle.BOX))
      .add(new TransformComponent()));

  screwBox.start();
}

Maven Central

ScrewBox dependencies can be downloaded from Maven Central:

<dependency>
  <groupId>dev.screwbox</groupId>
  <artifactId>screwbox-core</artifactId>
  <version>3.31.0</version>
</dependency>

Libraries used

The following libraries are used for testing and creating the documentation site. ScrewBox is entirely dependency-free, relying solely on the Java Standard Library.

• JUnit Eclipse Public License 2.0
• AssertJ Apache License 2.0
• Mockito MIT License
• Docusaurus MIT License
• Docusaurus Search Local Plugin MIT License

Acknowledgments

The project idea was inspired by Gurkenlabs Litiengine.