WorldLogger

This project was developed as my university final project, so it may have a number of shortcomings and unfinished details. However, its core features should be fully functional.

Introduction

This project is built on NeoForge for game version 26.1.2. It records specific information from the game world and provides users with a convenient way to view and manage that data.

Usage

This is primarily a server-side mod. However, clients must also have the mod installed in order to access the query functionality.

Once the mod has been installed on the server, edit the configuration file as shown below:

config/worldlogger/config.toml:

database_url: MySQL server url address

database_name: MySQL database name

database_username: MySQL user name

database_password: MySQL password

thread_number: Worker thread

These are the primary configuration options. The mod also includes AI integration and a set of related tools, enabling AI assistants to analyze database data and perform various data-processing tasks. To enable these features, simply provide an OpenAI-compatible API endpoint and API key.

Config is config/worldlogger/ai.toml

The client will also generate an ai.toml configuration file. However, the AI functionality on the client side is limited to chatting with the user and cannot access or operate on the database. In addition, all database-related operations provided by the server-side AI tools are strictly read-only.

The following commands can be used to query data stored in the database:

/minigame select <TABLE> [PAGE]: Query all data from the specified table.

/minigame search [PAGE]: Query all changes recorded in the database within a 16×16 area centered on the command executor.

/minigame ai <MESSAGE>: Send message to AI

/minigame ai reset: Reset the AI context.

Summary

All core logic of this mod runs on the server side. The client is only responsible for registering the GUI and sending network requests. Database storage, data processing, and AI-assisted data analysis are handled entirely by the server.

License

MIT