SessionAPI

The library facilitates game containerization on a Minecraft server, enabling the creation of isolated environments within the game with separate logic and state.

Structure

We define a container through three main types of components: `Session`, `Board`, and `Controller`.

• Session: It forms the foundation of the container, allowing the creation and management of container instances. It is responsible for adding new players to the container and removing existing ones.

• Board: It manages the game map within the container. All game elements and players reside on the Board, and interactions between them take place there. The Board serves as the space where the gameplay unfolds.

• Controller: It is a crucial component responsible for implementing the gameplay logic within the container. It contains listeners and threads that control the course of the game. The Controller reacts to player actions and manages various processes within the container.

Through these three types of components, our library enables the creation of flexible and complex container structures, providing full control over the gameplay flow and player interaction.

Encapsulation

Containers are created with encapsulation in mind, meaning they possess their unique state as well as individual player states. Additionally, they register running listeners and threads. The library ensures comprehensive management of container lifecycles. Upon destruction of a container instance, the system automatically terminates and removes all associated resources, such as running threads, listeners, controllers, generated maps, thus ensuring optimal resource utilization and preventing memory leaks and abandoned threads.

Hierarchy

In the architecture of the library, each component *(Session, Board, Controller)* is associated with an instance of the Process object.

Process object contains references to its parent component and a list of subordinate components created by it. This establishes a hierarchy of components, forming a tree structure where the root is the Session instance.

Upon termination of a specific component, the tree structure is analyzed, and then all subordinate components assigned to that resource are deactivated and removed.

Scalability

The library ensures high scalability by allowing for the simultaneous launch of multiple instances of the same type of container. This mechanism relies on generating a separate map for each instance and maintaining a separate, isolated game state. With this solution, each container instance operates independently of the others, minimizing mutual interference.

Important Links

• Official Documentation – Comprehensive, up-to-date resource for using and understanding SessionAPI, covering all key functionalities and advanced features.

• Getting Started Guide – Quick-start guide within the repository to help you set up and begin working with SessionAPI. For the latest information, see the official documentation.

Installation

1. Download the latest version of the SessionAPI plugin from the releases section.
2. Add SessionAPI.jar to the plugins folder on your Minecraft server.
3. Download the latest version of the FastAsyncWorldEdit plugin.
4. Add FastAsyncWorldEdit to the plugins folder on your Minecraft server.
5. Add SessionAPI.jar as a dependency in your Java project.
6. Set the dependency as compileOnly or provided.
7. In the plugin.yml file, add the following entry: depend: [SessionAPI]

Github Packages

Alternatively, you can add SessionAPI via Maven:

<repositories>
  <repository>
    <id>github</id>
    <url>https://maven.pkg.github.com/Szelagi/SessionAPI</url>
  </repository>
</repositories>

<dependency>
  <groupId>pl.szelagi</groupId>
  <artifactId>sessionapi</artifactId>
  <version>2.3.0-SNAPSHOT</version>
  <scope>provided</scope>
</dependency>