Skip to content

README.md

Latest commit

 

History

History
60 lines (44 loc) · 2.88 KB

README.md

File metadata and controls

60 lines (44 loc) · 2.88 KB
Raw

TPlayerDatabase

Release (latest by date) Workflow Status License Downloads Issues

What is this?

This is the source code of a .NET Framework library written in C#. It is a RocketMod plugin for Unturned 3.24.x+ servers that persists basic player information in a MySQL database.

Description

TPlayerDatabase is a lightweight data-collection plugin that tracks player identity across sessions. Whenever a player joins, the plugin records their Steam ID, Steam display name, in-game character name, and the timestamp of their last login.

Features

  • Player Tracking -- Records each player's Steam ID, Steam display name, character name, and last login time.
  • Automatic Updates -- Detects character name changes on reconnect and updates the database record accordingly.
  • MySQL Storage -- Persists all data in a MySQL database for reliable, server-side storage.
  • Async & Thread-Safe -- All database operations run asynchronously on background threads with per-player locking to prevent race conditions.
  • Graceful Error Handling -- Automatically unloads the plugin if the database connection fails, preventing log spam and server instability.

Requirements

  • Unturned 3.24.x or later
  • RocketMod installed on the server

Installation

  1. Download the latest release and its libraries from the Releases page.
  2. Place TPlayerDatabase.dll into your server's Rocket/Plugins/ directory.
  3. Extract the libraries archive into Rocket/Libraries directory.
  4. Start or restart the server. The plugin will generate a default YAML configuration file on first load.
  5. Edit the configuration file to your liking, then reload the plugin or restart the server.

Building from Source

Prerequisites

  • .NET Framework 4.8 SDK / targeting pack

Steps

  1. Clone the repository: 
    git clone https://github.com/TavstalDev/TPlayerDatabase.git
  2. Open TPlayerDatabase.sln in your IDE.
  3. Build the project: 
    dotnet build -c Release
  4. The output DLL will be at TPlayerDatabase/bin/Release/net48/TPlayerDatabase.dll.

License

This project is licensed under the GNU General Public License v3.0. See the LICENSE file for more details.

Contact

For issues or feature requests, please use the GitHub issue tracker.