KullGames_ServerLists_DataAccess 1.0.20241025.953

KullGames ServerLists DataAccess Library

Overview

KullGames.ServerLists.DataAccess is a .NET 8.0 data access library designed for Minecraft server listing, utilizing Entity Framework Core and MySQL. It provides a seamless way to interact with server listing data, perform CRUD operations, and integrate with various server-related functionalities.

Features

• Entity Framework Core: Supports EF Core for database access.
• MySQL Integration: Built for MySQL database operations.
• Minecraft Server Listings: Tailored to manage Minecraft server listings and related data.
• Extensible: Easily extendable to other Minecraft server operations.
• NuGet Package: Published as a NuGet package for easy integration.

Requirements

• .NET 8.0 SDK
• MySQL 8.0+
• Visual Studio 2022 or higher (optional for development)

Installation

Install the NuGet package in your project:

dotnet add package KullGames.ServerLists.DataAccess --version <version>

Or add the following to your .csproj file:

<PackageReference Include="KullGames.ServerLists.DataAccess" Version="<version>" />

Usage

Setting up the Context

using KullGames.ServerLists.DataAccess;
using Microsoft.EntityFrameworkCore;

public class ServerListContext : DbContext
{
    public DbSet<Server> Servers { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    {
        optionsBuilder.UseMySql("<your-connection-string>", 
            ServerVersion.AutoDetect("<your-connection-string>"));
    }
}

Sample Query

using (var context = new ServerListContext())
{
    var servers = context.Servers.ToList();
    foreach (var server in servers)
    {
        Console.WriteLine($"Server Name: {server.Name}");
    }
}

Project Structure

• KullGames.ServerLists.DataAccess: Main library for accessing server data.
• Models: Contains all the data models, including server details and associated metadata.

Building the Project

To build the project locally, follow these steps:

1. Clone the repository:

   git clone https://dev.azure.com/KullGamesRepo/KullGames/_git/KullGames_ServerLists
   

2. Navigate to the project directory:

   cd KullGames_ServerLists
   

3. Restore dependencies and build:

   dotnet restore
   dotnet build
   

Contributing

Contributions are welcome! Please follow the steps below:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/your-feature).
3. Commit your changes (git commit -am 'Add some feature').
4. Push to the branch (git push origin feature/your-feature).
5. Create a pull request.

License

This project is licensed under the CC BY-NC 4.0 License - see the LICENSE file for full details, below is a snippet of some key points.

You are free to:

- **Share**: Copy and redistribute the material in any medium or format.
- **Adapt**: Remix, transform, and build upon the material.

Under the following terms:

- **Attribution**: You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
- **NonCommercial**: You may not use the material for commercial purposes.

Contact

For questions or support, please visit KullGames or open an issue in the repository.

This README provides a detailed overview of the project, setup instructions, and usage examples. Let me know if you'd like to adjust any sections!