# AdminMonumentMarker
AdminMonumentMarker is a lightweight Rust plugin that automatically creates map markers for monuments and caves.
The plugin is designed for server administrators who want a quick visual overview of important map locations without manually placing markers.
---
# Features
* Automatically creates map markers when the server starts.
* Supports vanilla monuments.
* Supports cave detection.
* Configurable monument visibility.
* Configurable cave visibility.
* Admin-only management commands.
* Lightweight and wipe-safe.
* Automatically recreates markers after plugin reload.
---
# Installation
1. Place the plugin file into:
```
oxide/plugins/AdminMonumentMarker.cs
```
2. Reload the plugin:
```
oxide.reload AdminMonumentMarker
```
3. The configuration file will automatically be generated at:
```
oxide/config/AdminMonumentMarker.json
```
---
# Permissions
Permission:
```
adminmonumentmarker.admin
```
Grant permission to administrators:
```
oxide.grant group admin adminmonumentmarker.admin
```
Grant permission to a specific user:
```
oxide.grant user STEAMID64 adminmonumentmarker.admin
```
Example:
```
oxide.grant user 76561198000000000 adminmonumentmarker.admin
```
Remove permission:
```
oxide.revoke user STEAMID64 adminmonumentmarker.admin
```
---
# Configuration
Default configuration:
```json
{
"ShowCaves": true,
"ShowMonuments": true,
"MarkerRadius": 0.35,
"MarkerAlpha": 0.75,
"MonumentColor1": "0.1 0.45 1 0.75",
"MonumentColor2": "0.1 0.1 0.1 0.75",
"CaveColor1": "1 0.45 0.05 0.75",
"CaveColor2": "0.1 0.1 0.1 0.75"
}
```
---
## ShowCaves
Controls whether cave markers are created.
```json
"ShowCaves": true
```
Values:
```json
true
false
```
Example:
```json
"ShowCaves": false
```
Only monuments will be marked.
---
## ShowMonuments
Controls whether monument markers are created.
```json
"ShowMonuments": true
```
Values:
```json
true
false
```
Example:
```json
"ShowMonuments": false
```
Only caves will be marked.
---
## MarkerRadius
Controls marker size on the map.
Example:
```json
"MarkerRadius": 0.35
```
Larger values create larger circles.
---
## MarkerAlpha
Controls marker transparency.
Example:
```json
"MarkerAlpha": 0.75
```
Range:
```
0.0 = Invisible
1.0 = Fully Visible
```
---
## Marker Colors
Markers use RGBA format:
```
Red Green Blue Alpha
```
Example:
```json
"MonumentColor1": "0.1 0.45 1 0.75"
```
Color examples:
### Blue
```
"0.1 0.45 1 0.75"
```
### Green
```
"0 1 0 0.75"
```
### Red
```
"1 0 0 0.75"
```
### Yellow
```
"1 1 0 0.75"
```
---
# Commands
## Refresh Markers
Recreates all markers.
Chat:
```
/amm refresh
```
Console:
```
amm.refresh
```
---
## Clear Markers
Removes all active markers.
Chat:
```
/amm clear
```
Console:
```
amm.clear
```
---
## Count Markers
Displays the number of active markers.
Chat:
```
/amm count
```
---
# Cave Detection
The plugin automatically identifies cave monuments using monument names.
Supported cave types include:
* Small Cave
* Medium Cave
* Large Cave
* Cave monuments containing the word "cave"
Detection is automatic and requires no configuration.
---
# Server Restart Behavior
When the server starts:
1. Plugin loads.
2. Configuration is read.
3. Monument list is scanned.
4. Cave list is scanned.
5. Map markers are created automatically.
No manual action is required.
---
# Reload Behavior
When the plugin is reloaded:
```
oxide.reload AdminMonumentMarker
```
The plugin:
1. Removes existing markers.
2. Rescans monuments.
3. Recreates markers.
This prevents duplicate markers.
---
# Uninstall
Unload the plugin:
```
oxide.unload AdminMonumentMarker
```
Delete:
```
oxide/plugins/AdminMonumentMarker.cs
```
Optional:
```
oxide/config/AdminMonumentMarker.json
```
---
# Troubleshooting
## No markers appear
Check plugin status:
```
oxide.plugins
```
Verify the plugin loaded successfully.
---
## Permission denied
Grant permission:
```
oxide.grant group admin adminmonumentmarker.admin
```
Reload plugin:
```
oxide.reload AdminMonumentMarker
```
---
## Markers duplicated
Run:
```
/amm clear
```
Then:
```
/amm refresh
```
---
#
# Configuration changes not applied
After editing:
```
oxide.reload AdminMonumentMarker
```
or
```
/amm refresh
```
---
# Notes
* Markers are visual map circles only.
* The plugin does not create custom monument names.
* The plugin does not modify monuments.
* The plugin does not affect gameplay.
* The plugin is intended for administrative map visibility and server management.
AdminMonumentMarker is a lightweight Rust plugin that automatically creates map markers for monuments and caves.
The plugin is designed for server administrators who want a quick visual overview of important map locations without manually placing markers.
---
# Features
* Automatically creates map markers when the server starts.
* Supports vanilla monuments.
* Supports cave detection.
* Configurable monument visibility.
* Configurable cave visibility.
* Admin-only management commands.
* Lightweight and wipe-safe.
* Automatically recreates markers after plugin reload.
---
# Installation
1. Place the plugin file into:
```
oxide/plugins/AdminMonumentMarker.cs
```
2. Reload the plugin:
```
oxide.reload AdminMonumentMarker
```
3. The configuration file will automatically be generated at:
```
oxide/config/AdminMonumentMarker.json
```
---
# Permissions
Permission:
```
adminmonumentmarker.admin
```
Grant permission to administrators:
```
oxide.grant group admin adminmonumentmarker.admin
```
Grant permission to a specific user:
```
oxide.grant user STEAMID64 adminmonumentmarker.admin
```
Example:
```
oxide.grant user 76561198000000000 adminmonumentmarker.admin
```
Remove permission:
```
oxide.revoke user STEAMID64 adminmonumentmarker.admin
```
---
# Configuration
Default configuration:
```json
{
"ShowCaves": true,
"ShowMonuments": true,
"MarkerRadius": 0.35,
"MarkerAlpha": 0.75,
"MonumentColor1": "0.1 0.45 1 0.75",
"MonumentColor2": "0.1 0.1 0.1 0.75",
"CaveColor1": "1 0.45 0.05 0.75",
"CaveColor2": "0.1 0.1 0.1 0.75"
}
```
---
## ShowCaves
Controls whether cave markers are created.
```json
"ShowCaves": true
```
Values:
```json
true
false
```
Example:
```json
"ShowCaves": false
```
Only monuments will be marked.
---
## ShowMonuments
Controls whether monument markers are created.
```json
"ShowMonuments": true
```
Values:
```json
true
false
```
Example:
```json
"ShowMonuments": false
```
Only caves will be marked.
---
## MarkerRadius
Controls marker size on the map.
Example:
```json
"MarkerRadius": 0.35
```
Larger values create larger circles.
---
## MarkerAlpha
Controls marker transparency.
Example:
```json
"MarkerAlpha": 0.75
```
Range:
```
0.0 = Invisible
1.0 = Fully Visible
```
---
## Marker Colors
Markers use RGBA format:
```
Red Green Blue Alpha
```
Example:
```json
"MonumentColor1": "0.1 0.45 1 0.75"
```
Color examples:
### Blue
```
"0.1 0.45 1 0.75"
```
### Green
```
"0 1 0 0.75"
```
### Red
```
"1 0 0 0.75"
```
### Yellow
```
"1 1 0 0.75"
```
---
# Commands
## Refresh Markers
Recreates all markers.
Chat:
```
/amm refresh
```
Console:
```
amm.refresh
```
---
## Clear Markers
Removes all active markers.
Chat:
```
/amm clear
```
Console:
```
amm.clear
```
---
## Count Markers
Displays the number of active markers.
Chat:
```
/amm count
```
---
# Cave Detection
The plugin automatically identifies cave monuments using monument names.
Supported cave types include:
* Small Cave
* Medium Cave
* Large Cave
* Cave monuments containing the word "cave"
Detection is automatic and requires no configuration.
---
# Server Restart Behavior
When the server starts:
1. Plugin loads.
2. Configuration is read.
3. Monument list is scanned.
4. Cave list is scanned.
5. Map markers are created automatically.
No manual action is required.
---
# Reload Behavior
When the plugin is reloaded:
```
oxide.reload AdminMonumentMarker
```
The plugin:
1. Removes existing markers.
2. Rescans monuments.
3. Recreates markers.
This prevents duplicate markers.
---
# Uninstall
Unload the plugin:
```
oxide.unload AdminMonumentMarker
```
Delete:
```
oxide/plugins/AdminMonumentMarker.cs
```
Optional:
```
oxide/config/AdminMonumentMarker.json
```
---
# Troubleshooting
## No markers appear
Check plugin status:
```
oxide.plugins
```
Verify the plugin loaded successfully.
---
## Permission denied
Grant permission:
```
oxide.grant group admin adminmonumentmarker.admin
```
Reload plugin:
```
oxide.reload AdminMonumentMarker
```
---
## Markers duplicated
Run:
```
/amm clear
```
Then:
```
/amm refresh
```
---
#
# Configuration changes not applied
After editing:
```
oxide.reload AdminMonumentMarker
```
or
```
/amm refresh
```
---
# Notes
* Markers are visual map circles only.
* The plugin does not create custom monument names.
* The plugin does not modify monuments.
* The plugin does not affect gameplay.
* The plugin is intended for administrative map visibility and server management.
