# Sync Sign Notice Mod
A Minecraft Fabric mod that synchronizes sign content with a database and displays news items.
**THIS IS A CLIENT ONLY MOD.**
## Usage
1. Start Minecraft with Fabric Loader
2. The mod will automatically connect to the configured database
3. Signs with this format will display synchronized news items
## Configuration
Edit the config file at `run/config/sync-sign-notice/config.json`:
```json
{
"db_host": "example.com", // Database host address
"db_user": "ExampleUser", // Database username
"db_password": "ExamplePassword", // Database password
"db_database": "example_db", // Database name
"db_port": 3306, // Database port (default: 3306)
"maxNewsCount": 5, // Maximum number of news items to display
"autoRefreshInterval": 300 // Auto-refresh interval in seconds (default: 300)
}
```
## Sign Setup
To create a synchronized notice sign in your Minecraft world:
1. Place a sign (any wood type)
2. Edit the sign text as follows:
- Line 1: `[Notice]` (exactly like this)
- Line 2: News item number (from the newest item to the oldest, starting from 1, no more than `maxNewsCount`)
- Line 3: (Leave blank or put custom text)
- Line 4: `SyncSign` (exactly like this)
Example sign text:
```
[Notice]
1
Welcome!
SyncSign
```
For more setting up instruction and trouble shooting, please visit Github Repositry.
