docs: add READMEs and wiki documentation for all directories

- Add comprehensive wiki documentation under .github/wiki/ (19 articles)
- Add READMEs to directories that lacked them
- Fix merge conflict markers in existing READMEs
- Update root readme.md with improved structure

Co-authored-by: Jarvis <jarvis@wickedyoda.local>
This commit is contained in:
WickedYodaandJarvis authored and GitHub committed 2026-09-04 12:31:11 -05:00
1 parent b40aaf6f0e
commit 0c62f7495a
42 files changed
+4501 -865

No files matched your search

+35 -32
View File
@@ -1,40 +1,43 @@
# copy_palworld_local
<<<<<<< HEAD
## Purpose
This directory contains files related to **copy palworld local**.
## Contents
- `copy_palworld_local.py`
## Usage
- Review each script or configuration file before running
- Some scripts may require **root or sudo**
- Paths and variables may need adjustment for your environment
## Notes
- This folder is part of the **public-setupfiles** repository
- Files are provided as-is for reference or automation
## Safety
Always back up data before running scripts that modify system state.
=======
## Overview
This directory is part of the **public-setupfiles** repository.
It contains scripts, configuration files, or resources related to **copy_palworld_local**.
Python script for backing up Palworld server data to local storage or NAS.
## Files
| File | Description |
|------|-------------|
| `copy_palworld_local.py` | Main backup script |
## Usage
- Review scripts before execution
- Some files may require **root or sudo privileges**
- Paths, variables, or credentials may need customization
## Logging & Output
Scripts may generate logs or output files in the same directory or system locations.
## Safety Notes
- Always back up important data before running scripts
- Test in a non-production environment when possible
- Use at your own risk
```bash
python3 copy-palworld-local/copy_palworld_local.py
```
---
>>>>>>> main
## Configuration
Edit `copy_palworld_local.py` to set:
- Source directory (Palworld server data)
- Destination directory (local/NAS)
- Backup retention period
---
## Features
- Checks if destination exists
- Creates timestamped backup folders
- Handles permission errors gracefully
- Logs operation results
---
## Requirements
- Python 3.x
- Permissions to read Palworld server data
- Write access to destination