Skip to content

Commit 3ce58ac

Browse files
authored
Add files via upload
1 parent 4808ec4 commit 3ce58ac

3 files changed

Lines changed: 1929 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# SmartCleanup Changelog
2+
3+
## v0.3.1
4+
5+
- Added default Always Allow Cleanup prefabs:
6+
- campfire
7+
- lantern.deployed
8+
- bbq.deployed
9+
- Improved config migration logic
10+
- Updated config schema to version 6
11+
12+
## v0.3.0
13+
14+
- Production ready build
15+
- Added testing mode (Disable Scheduled Cleanup For Testing)
16+
- Added scheduled cleanup logging controls
17+
- Improved deployable classification
18+
- Improved rebuild logic to preserve entity age
19+
- Reduced console spam from scheduled runs
20+
- Improved dry-run reporting (WouldRemove)
21+
22+
## v0.2.x
23+
24+
- Added deployable cleanup categories
25+
- Added force-allow and never-clean prefab lists
26+
- Added protected reason reporting
27+
- Fixed recent-owner protection override
28+
29+
## v0.1.x
30+
31+
- Initial SmartCleanup rewrite
32+
- Added TC privilege protection
33+
- Added disconnected structure cleanup
34+
- Implemented manual admin commands

README.md

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
# SmartCleanup (Rust / uMod Plugin)
2+
3+
**Author:** SeesAll\
4+
**Version:** 0.3.1
5+
6+
SmartCleanup is a modern replacement for legacy Rust cleanup plugins
7+
such as EntityCleanup. It safely removes abandoned structures and
8+
deployables while protecting legitimate player builds.
9+
10+
------------------------------------------------------------------------
11+
12+
## Why SmartCleanup Exists
13+
14+
Older cleanup plugins treated all deployables the same which could lead
15+
to: - accidental removal of legitimate player storage - unsafe cleanup
16+
inside base areas - unnecessary performance overhead
17+
18+
SmartCleanup introduces category-aware cleanup, safer privilege
19+
detection, and performance-focused evaluation.
20+
21+
------------------------------------------------------------------------
22+
23+
## Key Features
24+
25+
### Intelligent Cleanup Categories
26+
27+
Server owners can control which deployable types are eligible for
28+
cleanup:
29+
30+
- Production deployables (furnaces, BBQs, campfires)
31+
- Lighting deployables (lanterns, tuna lamps)
32+
- Traps (bear traps, landmines, spike traps)
33+
- Utility deployables
34+
- Water and farming deployables
35+
- Electrical and industrial deployables
36+
- Storage deployables
37+
- Workbench deployables
38+
- Privilege deployables
39+
- Commerce deployables
40+
41+
------------------------------------------------------------------------
42+
43+
### Safety Systems
44+
45+
SmartCleanup includes multiple layers of protection:
46+
47+
- TC privilege detection
48+
- Connected structure protection
49+
- Recent player activity protection
50+
- Health thresholds
51+
- Never-clean prefab list
52+
- Force-allow prefab list
53+
54+
These systems prevent accidental cleanup of legitimate bases.
55+
56+
------------------------------------------------------------------------
57+
58+
### Server Profiles
59+
60+
SmartCleanup supports preset environments:
61+
62+
1. Auto Detect
63+
2. Fast PvP
64+
3. Balanced
65+
4. PvE / Conservative
66+
5. Custom
67+
68+
Profiles automatically adjust cleanup timings based on server style.
69+
70+
------------------------------------------------------------------------
71+
72+
### Performance-Focused Design
73+
74+
Compared to older cleanup plugins SmartCleanup improves performance by:
75+
76+
- Tracking cleanup candidates instead of repeatedly scanning all
77+
entities
78+
- Evaluating entities in controlled batches
79+
- Running scheduled checks at configurable intervals
80+
- Avoiding unnecessary processing of protected structures
81+
82+
This design scales significantly better on medium and large Rust
83+
servers.
84+
85+
------------------------------------------------------------------------
86+
87+
### Logging Controls
88+
89+
Admins can choose how much information appears in console:
90+
91+
- Debug logging
92+
- Scheduled cleanup summaries
93+
- Removal-only logging (recommended for production)
94+
95+
------------------------------------------------------------------------
96+
97+
## Default Always-Allow Cleanup Prefabs
98+
99+
SmartCleanup always allows cleanup for common clutter deployables:
100+
101+
campfire
102+
lantern.deployed
103+
bbq.deployed
104+
105+
These objects are frequently abandoned across the map and safe to remove
106+
when outside TC.
107+
108+
------------------------------------------------------------------------
109+
110+
## Admin Commands
111+
112+
/smartcleanup status
113+
/smartcleanup dryrun
114+
/smartcleanup run
115+
/smartcleanup rebuild
116+
117+
### Command Descriptions
118+
119+
Command Description
120+
----------------------- ---------------------------------------------
121+
/smartcleanup status Shows current runtime configuration
122+
/smartcleanup dryrun Simulates cleanup without removing entities
123+
/smartcleanup run Executes cleanup immediately
124+
/smartcleanup rebuild Rebuilds the internal candidate tracker
125+
126+
------------------------------------------------------------------------
127+
128+
## Testing Mode
129+
130+
For testing cleanup behaviour administrators can disable scheduled
131+
cleanup:
132+
133+
"Disable Scheduled Cleanup For Testing": true
134+
135+
------------------------------------------------------------------------
136+
137+
## Performance Notes
138+
139+
SmartCleanup was built with performance in mind.
140+
141+
Compared to legacy plugins it:
142+
143+
- reduces full entity scans
144+
- processes entities in controlled batches
145+
- skips protected structures early
146+
- uses category filtering to minimize work
147+
148+
The result is a cleanup system that scales much better on long-wipe
149+
servers with large entity counts.
150+
151+
------------------------------------------------------------------------
152+
153+
## License
154+
155+
MIT License

0 commit comments

Comments
 (0)