Alis.Core.Aspect.Thread 0.6.4

Develop the video games of your dreams 💯 free!! on Windows, MacOS, Linux, Android(soon), IOS(soon).

📚 Alis.Core.Aspect.Thread

• Modular Design
• Description
• Getting Started
• License
• Contributor Guide
• Authors
• Collaborators

⚙️ Modular Design

All modules within the Alis framework, including Alis.Core.Aspect.Thread, are fully independent and can be used separately. While the primary focus of Alis is game development, these modules are designed to be versatile and can be integrated into other types of applications or environments where thread management, task execution, or concurrency handling are needed.

🖥️ Platform Compatibility

The Alis framework, including Alis.Core.Aspect.Thread, is designed to support a wide range of platforms, ensuring flexibility and adaptability for developers. Each module is optimized for seamless integration across the following architectures and operating systems:

Supported Platforms:

• Windows
  • win-x64
  • win-x86
  • win-arm64
• Linux
  • linux-x64
  • linux-musl-x64
  • linux-arm
  • linux-arm64
  • linux-musl-arm
  • linux-musl-arm64
• macOS
  • osx-x64
  • osx-arm64

📖 Description

Alis.Core.Aspect.Thread is a module within the Alis framework designed to manage the execution of tasks in separate threads. This module includes classes to define tasks that run in parallel, as well as a manager to handle the lifecycle of multiple threads.

Features:

• Task Management: Encapsulate tasks that can be executed in separate threads with cancellation support.
• Thread Management: Manage the starting and stopping of multiple threads and track the active threads.
• Cancellation Support: Gracefully handle task cancellation through the use of CancellationToken.
• Main Classes:
  • ThreadTask: Encapsulates a task to be executed on a separate thread.
  • ThreadManager: Manages multiple ThreadTask instances, starting, stopping, and tracking threads.

🚀 Getting Started

To start using Alis.Core.Aspect.Thread, simply install the package:

dotnet add package Alis.Core.Aspect.Thread

This module is ideal for applications that need to run concurrent tasks in separate threads.

Basic Usage Example:

public static void Main(string[] args)
{
    ThreadManager threadManager = new ThreadManager();

    CancellationTokenSource cts1 = new CancellationTokenSource();
    ThreadTask task1 = new ThreadTask(token =>
    {
        for (int i = 0; (i < 10) && !token.IsCancellationRequested; i++)
        {
           Logger.Info($"Task 1 - Count: {i}");
            System.Threading.Thread.Sleep(1000);
        }
    }, cts1.Token);

    CancellationTokenSource cts2 = new CancellationTokenSource();
    ThreadTask task2 = new ThreadTask(token =>
    {
        for (int i = 0; (i < 10) && !token.IsCancellationRequested; i++)
        {
           Logger.Info($"Task 2 - Count: {i}");
            System.Threading.Thread.Sleep(1000);
        }
    }, cts2.Token);

    threadManager.StartThread(task1);
    threadManager.StartThread(task2);

   Logger.Info("Press any key to stop threads...");
    Console.ReadKey();

    threadManager.StopAllThreads();

   Logger.Info("Press any key to exit...");
    Console.ReadKey();
}

🛡️ License

The ALIS framework is released under the GNU General Public License v3 (GPL-3.0), a strong copyleft license that ensures your freedom to use, modify, and distribute the framework while preserving the same license terms. Below is an explanation of how the license affects you as a developer:

Key License Points

• Complete Freedom for Video Game Developers:
  Any video game created with the ALIS framework is completely free and unrestricted. You are free to create, publish, and distribute your games without any licensing fees or royalties.

• Source Code Availability:
  If you make modifications to the ALIS framework itself or integrate it as part of a larger software project (beyond just using it in a video game), you are required to make those changes publicly available under the same GPL-3.0 license. This ensures the framework remains open and accessible to everyone.

• No Obligation to Mention:
  While it’s not required, it would be greatly appreciated if you mention or credit the ALIS project somewhere in your game, such as in the credits or documentation. This is entirely optional and is meant to help grow the ALIS community.

• Patent Rights:
  Contributors to ALIS provide an express grant of patent rights, meaning you’re protected from patent-related legal issues when using the framework.

• Copyright and Notices:
  You must preserve copyright notices and license texts when redistributing ALIS, either in its original form or as part of a modified version.

What This Means for Your Games

• Your Game’s License:
  The GPL-3.0 license applies only to the ALIS framework and its modifications. It does not impose restrictions on the license of the game you build using ALIS. You are free to license your game however you choose (e.g., proprietary, open-source, or public domain).

• Monetization:
  You are free to monetize games created with ALIS, whether by selling them, integrating ads, or any other form of commercialization.

Contributor Guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected. Read our Code of Conduct to keep our community approachable and respectable.

Authors

Pablo Perdomo Falcón

Collaborators

Raúl Lozano Ponce	Juan Ángel Trujillo Jiménez	Pablo Perdomo Falcón	Christian García	RicardoVillarta

Gabriel	Pedro D.GR	Claudia2000pf	Carlos	Roser Almenar