ArcaneSunku / eclipse-origins

A Java 2D ORPG engine

Eclipse Origins 4: Solar Eclipse

Welcome to Eclipse Origins 4, a love letter to Visual Basic 2D ORPG Engines.

  This build, nicknamed Solar Eclipse, is version 4.3.1.1-alpha.

Table of Contents

• Requirements
• Project Overview
• Sub-projects
  • Core
  • Server
  • Editor
  • Client
• Building
  • Clean and Build All
  • Clean and Build Core
  • Clean and Build Server
  • Clean and Build Editor
  • Clean and Build Client
• Execution
  • Running the Server
  • Running the Editor
  • Running the Client
• Distribution
• Errata

Requirements

• Written in Java 17
• • OpenJDK "Temurin" version 21-0.3+9 (Eclipse Adoptium JRE)
• Built with: Gradle 8.5 (Groovy configuration)

Currently only tested on Windows 10 & 11.

Project Overview

Version strings follow the MAJOR(#?).MODEL(#??).CONTROLLER(#??).VIEW(#??)-MILESTONE format.

So, Solar Eclipse (v4) is currently using Model v3, Controller v1, View v1, and is in its alpha milestone.

The project's packages and modules exist within the dev.atomixsoft.solar_eclipse namespace. The only module is core - server, editor, and client sub-projects are comprised of a series of packages.

Module	Package	Description
Core	Game	TODO
Core	Utils	TODO
Core	Network	TODO
N/A	Server	TODO
N/A	Editor	TODO
N/A	Client	TODO
N/A	ClientAudio	TODO
N/A	ClientGraphics	TODO
N/A	ClientScene	TODO
N/A	ClientUtil	TODO

Sub-projects

Core

The core sub-project includes essential libraries and classes shared across the other sub-projects.

| Dependencies:

• apache-commons-configuration 2.10.1
• apache-commons-logging 1.3.2
• junit-jupiter 5.10.0

Server

The server sub-project handles the back-end operations of the game.

| Dependencies:

• :core

Editor

The editor sub-project provides tools for developers to create and manage game content.

| Dependencies:

• :core

Client

The client sub-project is the game front-end.

| Dependencies:

• :core
• lwjgl 3.3.3
• • joml 1.10.5
• • imgui-java 1.86.11

Building

Clean and Build All

To clean & build all sub-projects, execute the following:

./gradlew clean 
./gradlew build

Clean and Build Core

You must build, preferably in a clean environment, the core sub-project before building server, editor, or client.

To clean & build only the core sub-project, execute the following:

./gradlew :core:clean 
./gradlew :core:build

Clean and Build Server

To clean & build only the server sub-project, execute the following:

./gradlew :server:clean 
./gradlew :server:build

Clean and Build Editor

To clean & build only the editor sub-project, execute the following:

./gradlew :editor:clean 
./gradlew :editor:build

Clean and Build Client

To clean & build only the client sub-project, execute the following:

./gradlew :client:clean 
./gradlew :client:build

Execution

Running the Server

You must run the server sub-project before editor or client.

To run the server, execute the following:

./gradlew :server:run

To run server in debug mode, execute the following instead:

./gradlew :server:debug

Running the Editor

To run the editor, execute the following:

./gradlew :editor:run

To run editor in debug mode, execute the following instead:

./gradlew :editor:debug

Running the Client

To run the client, execute the following:

./gradlew :client:run

To run client in debug mode, execute the following instead:

./gradlew :client:debug

Distribution

| TODO

Errata

Current planned Milestones are alpha, beta, rc1, rc2, and rtm.

For a little background, take a look at these links:

• Eclipse - Free MMORPG Maker - Index
• Forums - Eclipse Origins

Of course, make sure you also visit us at [atomixsoft.dev] !

We hope you find Eclipse Origins 4: Solar Eclipse a very clean, somewhat nostalgic, highly performant, and infinitely flexible engine. For any issues or contributions, please refer to our issue tracker or contributing guide.

Enjoy!