# WorldContainerCleaner Wiki / Full Documentation

---

# English Documentation

## Overview

WorldContainerCleaner is a lightweight utility plugin for Minecraft servers that need to clean items left inside containers after wipes, map resets, event resets, or seasonal resets.

The plugin does not break, remove, or replace blocks. It only clears the items stored inside containers.

This is useful for cleaning:

- Spawn worlds
- Event worlds
- Resource worlds
- Old maps
- Protected areas
- Non-playable worlds
- Reset zones
- Seasonal maps

---

## Main Features

- Clears items from container inventories
- Does not remove container blocks
- Supports entire world cleanup
- Supports WorldGuard region cleanup
- Supports dry-run scan before real cleanup
- Shows cleanup status and progress
- Allows stopping a running cleanup task
- Reloadable configuration
- Useful after wipes, resets, and events
- Simple command system

---

## Supported Containers

WorldContainerCleaner can clean inventories from containers such as:

- Chest
- Trapped Chest
- Barrel
- Shulker Box
- Hopper
- Furnace
- Blast Furnace
- Smoker
- Dispenser
- Dropper
- Brewing Stand
- Other Bukkit inventory holder containers

Only the items inside these containers are removed.

The container blocks stay in place.

---

## Installation

1. Download the plugin `.jar` file.
2. Place the `.jar` file into your server's `plugins` folder.
3. Restart the server.
4. Open the generated `config.yml` file.
5. Configure the worlds or WorldGuard regions you want to clean.
6. Run `/cleanstorage dryrun` before cleaning.
7. If the dry-run result is correct, run `/cleanstorage start`.

---

## Requirements

- Java 21+
- Paper 1.21+
- Spigot 1.21+
- WorldGuard is optional

WorldGuard is only required if you want to clean specific WorldGuard regions.

If you only want to clean entire worlds, WorldGuard is not required.

---

## Configuration

Example configuration:

```yaml
targets:
- world: spawn
region: "*"

- world: events
region: bossarena
```

---

## Configuration Fields

| Field | Description |
|------|-------------|
| `world` | The name of the world that should be scanned |
| `region` | The WorldGuard region name or whole-world value |

---

## Region Values

| Value | Meaning |
|------|---------|
| `*` | Clean the entire world |
| `__global__` | Clean the entire world |
| `region_name` | Clean only the selected WorldGuard region |

---

## Cleaning an Entire World

To clean all containers in a world, use:

```yaml
targets:
- world: spawn
region: "*"
```

You can also use:

```yaml
targets:
- world: spawn
region: "__global__"
```

Both values mean the entire world.

---

## Cleaning a Specific WorldGuard Region

To clean only one WorldGuard region, enter the region name in the config.

Example:

```yaml
targets:
- world: spawn
region: spawn
```

In this example, only containers inside the `spawn` WorldGuard region will be cleaned.

---

## Cleaning Multiple Targets

You can configure multiple worlds or regions.

Example:

```yaml
targets:
- world: spawn
region: "*"

- world: events
region: arena

- world: resource
region: "__global__"
```

This allows the plugin to clean several targets from one configuration.

---

## Commands

### /cleanstorage dryrun

Scans the configured worlds or regions and shows how many containers would be cleaned.

This command does not delete any items.

Use this command before every real cleanup.

Example:

```text
/cleanstorage dryrun
```

---

### /cleanstorage start

Starts the real cleanup process.

All items inside supported containers in configured targets will be removed.

Example:

```text
/cleanstorage start
```

---

### /cleanstorage status

Shows the current cleanup status and progress.

Example:

```text
/cleanstorage status
```

---

### /cleanstorage stop

Stops the currently running cleanup task.

Example:

```text
/cleanstorage stop
```

---

### /cleanstorage reload

Reloads the plugin configuration.

Use this command after editing `config.yml`.

Example:

```text
/cleanstorage reload
```

---

## Recommended Safe Workflow

Recommended workflow before cleaning containers:

1. Edit `config.yml`.
2. Add the worlds or WorldGuard regions you want to clean.
3. Run:

```text
/cleanstorage dryrun
```

4. Check the reported result.
5. Make sure you have a server backup.
6. Run:

```text
/cleanstorage start
```

7. Check cleanup progress with:

```text
/cleanstorage status
```

---

## Important Warning

WorldContainerCleaner permanently deletes items from container inventories.

Deleted items cannot be restored by the plugin.

Always create a backup before running a real cleanup.

Always test your configuration first with:

```text
/cleanstorage dryrun
```

---

## Example Use Cases

### Cleaning Spawn After Wipe

```yaml
targets:
- world: spawn
region: "*"
```

This will clean all containers in the `spawn` world.

---

### Cleaning Only Event Arena

```yaml
targets:
- world: events
region: arena
```

This will clean only containers inside the `arena` WorldGuard region.

---

### Cleaning Resource World

```yaml
targets:
- world: resource
region: "__global__"
```

This will clean all containers in the `resource` world.

---

## Notes

- The plugin does not remove blocks.
- The plugin only clears container inventories.
- If WorldGuard is installed, region-based cleanup can be used.
- If you use `*` or `__global__`, the entire world will be scanned.
- Always use dry-run before starting the cleanup.
- Always create a backup before real cleanup.

---

# O'zbekcha Dokumentatsiya

## Umumiy Ma'lumot

WorldContainerCleaner — Minecraft serverlarda wipe, map reset, event reset yoki sezon resetdan keyin container ichida qolib ketgan itemlarni tozalash uchun mo‘ljallangan yengil utility plugin.

Plugin bloklarni buzmaydi, o‘chirmaydi yoki almashtirmaydi.

U faqat container ichidagi itemlarni tozalaydi.

Bu quyidagilar uchun foydali:

- Spawn world
- Event world
- Resource world
- Eski maplar
- Himoyalangan hududlar
- O‘ynalmaydigan worldlar
- Reset qilinadigan hududlar
- Sezon maplari

---

## Asosiy Imkoniyatlar

- Container ichidagi itemlarni tozalaydi
- Container bloklarini buzmaydi
- Butun worldni tozalashni qo‘llab-quvvatlaydi
- WorldGuard regionlarni qo‘llab-quvvatlaydi
- Haqiqiy tozalashdan oldin dry-run tekshiruv bor
- Tozalash holati va progressini ko‘rsatadi
- Ishlayotgan tozalash jarayonini to‘xtatish mumkin
- Config reload qilish mumkin
- Wipe, reset va eventlardan keyin ishlatish uchun qulay
- Oddiy buyruqlar tizimi

---

## Qo‘llab-quvvatlanadigan Containerlar

WorldContainerCleaner quyidagi container ichidagi itemlarni tozalashi mumkin:

- Chest
- Trapped Chest
- Barrel
- Shulker Box
- Hopper
- Furnace
- Blast Furnace
- Smoker
- Dispenser
- Dropper
- Brewing Stand
- Boshqa Bukkit inventory holder containerlar

Faqat container ichidagi itemlar o‘chiriladi.

Container bloklari joyida qoladi.

---

## O‘rnatish

1. Plugin `.jar` faylini yuklab oling.
2. `.jar` faylni serveringizdagi `plugins` papkasiga joylashtiring.
3. Serverni restart qiling.
4. Yaratilgan `config.yml` faylini oching.
5. Tozalanadigan world yoki WorldGuard regionlarni sozlang.
6. Avval `/cleanstorage dryrun` buyrug‘ini ishlating.
7. Natija to‘g‘ri bo‘lsa, `/cleanstorage start` buyrug‘ini ishlating.

---

## Talablar

- Java 21+
- Paper 1.21+
- Spigot 1.21+
- WorldGuard ixtiyoriy

WorldGuard faqat aniq regionlarni tozalamoqchi bo‘lsangiz kerak bo‘ladi.

Agar faqat butun worldlarni tozalamoqchi bo‘lsangiz, WorldGuard shart emas.

---

## Config Sozlamasi

Config namunasi:

```yaml
targets:
- world: spawn
region: "*"

- world: events
region: bossarena
```

---

## Config Maydonlari

| Maydon | Tavsif |
|------|--------|
| `world` | Tekshiriladigan world nomi |
| `region` | WorldGuard region nomi yoki butun world qiymati |

---

## Region Qiymatlari

| Qiymat | Ma'nosi |
|------|---------|
| `*` | Butun worldni tozalaydi |
| `__global__` | Butun worldni tozalaydi |
| `region_name` | Faqat tanlangan WorldGuard regionni tozalaydi |

---

## Butun Worldni Tozalash

Butun worlddagi containerlarni tozalash uchun quyidagicha yoziladi:

```yaml
targets:
- world: spawn
region: "*"
```

Yoki quyidagicha yozish mumkin:

```yaml
targets:
- world: spawn
region: "__global__"
```

Ikkalasi ham butun world degani.

---

## Aniq WorldGuard Regionni Tozalash

Faqat bitta WorldGuard regionni tozalash uchun configga region nomini yozing.

Namuna:

```yaml
targets:
- world: spawn
region: spawn
```

Bu holatda faqat `spawn` WorldGuard region ichidagi containerlar tozalanadi.

---

## Bir Nechta Targetni Tozalash

Bir nechta world yoki regionni bitta config orqali sozlash mumkin.

Namuna:

```yaml
targets:
- world: spawn
region: "*"

- world: events
region: arena

- world: resource
region: "__global__"
```

Bu plugin orqali bir nechta hududni ketma-ket tozalash imkonini beradi.

---

## Buyruqlar

### /cleanstorage dryrun

Configda ko‘rsatilgan world yoki regionlarni tekshiradi va nechta container tozalanishini ko‘rsatadi.

Bu buyruq itemlarni o‘chirmaydi.

Har bir haqiqiy tozalashdan oldin ishlatish tavsiya etiladi.

Namuna:

```text
/cleanstorage dryrun
```

---

### /cleanstorage start

Haqiqiy tozalash jarayonini boshlaydi.

Configda ko‘rsatilgan hududlardagi qo‘llab-quvvatlanadigan containerlar ichidagi barcha itemlar o‘chiriladi.

Namuna:

```text
/cleanstorage start
```

---

### /cleanstorage status

Tozalash jarayonining hozirgi holati va progressini ko‘rsatadi.

Namuna:

```text
/cleanstorage status
```

---

### /cleanstorage stop

Hozir ishlayotgan tozalash jarayonini to‘xtatadi.

Namuna:

```text
/cleanstorage stop
```

---

### /cleanstorage reload

Plugin config faylini qayta yuklaydi.

`config.yml` o‘zgartirilgandan keyin ishlatiladi.

Namuna:

```text
/cleanstorage reload
```

---

## Tavsiya Qilingan Xavfsiz Ishlatish Tartibi

Containerlarni tozalashdan oldin quyidagi tartib tavsiya qilinadi:

1. `config.yml` faylini tahrirlang.
2. Tozalanadigan world yoki WorldGuard regionlarni qo‘shing.
3. Quyidagi buyruqni ishlating:

```text
/cleanstorage dryrun
```

4. Natijani tekshiring.
5. Server backup borligiga ishonch hosil qiling.
6. Quyidagi buyruqni ishlating:

```text
/cleanstorage start
```

7. Progressni ko‘rish uchun quyidagi buyruqdan foydalaning:

```text
/cleanstorage status
```

---

## Muhim Ogohlantirish

WorldContainerCleaner container ichidagi itemlarni butunlay o‘chiradi.

O‘chirilgan itemlarni plugin orqali qaytarib bo‘lmaydi.

Haqiqiy tozalashdan oldin har doim backup oling.

Avval configni quyidagi buyruq bilan tekshiring:

```text
/cleanstorage dryrun
```

---

## Ishlatish Namunalari

### Wipe’dan Keyin Spawnni Tozalash

```yaml
targets:
- world: spawn
region: "*"
```

Bu `spawn` worldidagi barcha containerlarni tozalaydi.

---

### Faqat Event Arenani Tozalash

```yaml
targets:
- world: events
region: arena
```

Bu faqat `arena` WorldGuard region ichidagi containerlarni tozalaydi.

---

### Resource Worldni Tozalash

```yaml
targets:
- world: resource
region: "__global__"
```

Bu `resource` worldidagi barcha containerlarni tozalaydi.

---

## Eslatmalar

- Plugin bloklarni o‘chirmaydi.
- Plugin faqat container ichidagi itemlarni tozalaydi.
- WorldGuard o‘rnatilgan bo‘lsa, region bo‘yicha tozalash ishlaydi.
- `*` yoki `__global__` ishlatilsa, butun world tekshiriladi.
- Har doim haqiqiy tozalashdan oldin dry-run ishlating.
- Haqiqiy tozalashdan oldin backup olish tavsiya etiladi.