minecraft-mod/Essentials/README.md

118 lines
3.7 KiB
Markdown
Raw Normal View History

# ⚙️ Essentials
마인크래프트 서버 필수 기능을 제공하는 NeoForge 모드입니다.
![NeoForge](https://img.shields.io/badge/NeoForge-21.1.194-orange?logo=curseforge)
![Minecraft](https://img.shields.io/badge/Minecraft-1.21.1-green)
![Kotlin](https://img.shields.io/badge/Kotlin-2.0-7F52FF?logo=kotlin)
---
## ✨ 주요 기능
2025-12-17 19:15:05 +09:00
- 📍 **좌표 관리** - 좌표 저장 및 텔레포트
- 🏷️ **닉네임 시스템** - 플레이어 닉네임 설정
- 🏠 **스폰 관리** - 커스텀 스폰 지점 설정
- 🚀 **텔레포트** - 플레이어 간 텔레포트
2025-12-17 19:15:05 +09:00
- 🛡️ **안티몹** - 특정 몹 패턴 비활성화
- 🌾 **밭 보호** - 밟아도 밭이 망가지지 않도록 보호
- 💬 **채팅 관리** - 채팅 형식 변경
---
## 🎮 명령어
### 좌표 관리
| 명령어 | 설명 |
| ------------------ | -------------------- |
2025-12-17 19:15:05 +09:00
| `/좌표` | 저장된 좌표 목록 |
| `/좌표추가 <이름>` | 현재 위치 좌표 저장 |
| `/좌표제거 <이름>` | 저장된 좌표 삭제 |
| `/좌표이동 <이름>` | 해당 좌표로 텔레포트 |
### 스폰
| 명령어 | 설명 |
| -------------------------- | ------------------------- |
| `/스폰`, `/spawn`, `/넴주` | 스폰으로 이동 |
| `/스폰설정`, `/setspawn` | 현재 위치를 스폰으로 설정 |
| `/스폰삭제`, `/delspawn` | 커스텀 스폰 삭제 |
### 텔레포트
| 명령어 | 설명 |
| ---------------------------- | ----------------- |
| `/텔레포트`, `/텔포`, `/tpa` | 플레이어 선택 GUI |
| `/back`, `/백` | 이전 위치로 이동 |
### 닉네임
2025-12-17 19:06:41 +09:00
| 명령어 | 설명 |
| ----------------------- | ------------- |
| `/닉네임 변경 <닉네임>` | 닉네임 설정 |
| `/닉네임 초기화` | 닉네임 초기화 |
| `/nickname set <name>` | 닉네임 설정 |
| `/nickname reset` | 닉네임 초기화 |
### 안티몹
2025-12-17 19:15:05 +09:00
| 명령어 | 설명 |
| --------------------- | ----------- |
| `/안티몹`, `/antimob` | 안티몹 설정 |
### 밭 보호
| 명령어 | 설명 |
| ----------------------------- | ------------ |
| `/밭보호`, `/protectfarmland` | 밭 보호 토글 |
### 채팅 (관리자)
| 명령어 | 설명 |
| -------------------------------- | ------------------------- |
| `/채팅 새로고침`, `/chat reload` | 채팅 형식 새로고침 |
| `/채팅 비우기`, `/chat clear` | 모든 플레이어 채팅 비우기 |
---
## 🛠️ 기술 스택
| 기술 | 설명 |
| -------------------- | --------------------- |
| **NeoForge** | Minecraft 모딩 플랫폼 |
| **Kotlin** | 주 개발 언어 |
| **Kotlin for Forge** | NeoForge Kotlin 지원 |
| **Java 21** | JVM 버전 |
---
## 📁 구조
```
Essentials/
├── src/main/
│ ├── kotlin/com/beemer/essentials/
│ │ ├── command/ # 커맨드 핸들러
│ │ ├── config/ # 설정 관리
│ │ ├── data/ # 데이터 모델
│ │ ├── event/ # 이벤트 핸들러
│ │ ├── gui/ # GUI 메뉴
│ │ ├── nickname/ # 닉네임 시스템
│ │ └── util/ # 유틸리티
│ ├── java/.../mixin/ # Mixin 클래스
│ └── resources/
│ └── META-INF/ # 모드 메타데이터
└── build.gradle
```
---
## 🚀 빌드
```bash
./gradlew build
```
빌드된 JAR: `build/libs/essentials-1.0.0.jar`