docs: correct README commands/cache/config to actual v0.4.35 API
All checks were successful
build / build (push) Successful in 1m21s
All checks were successful
build / build (push) Successful in 1m21s
The prior README still listed the old lowercase commands and /videopreload. Bring it in line with the registered commands and config: - Commands are camelCase and case-sensitive: /videoStick, /videoPlace, /videoDelete, /videoMute, /videoCache. Document both /videoPlace forms (5-arg legacy + 6-arg with volume -1..100) and the 1–32 w/h, facing range. - Replace the removed /videopreload with /videoCache add|list|remove|clear; note named entries persist in config (cache_entries) and resolve in the /videoPlace url slot, remove() cancels in-flight downloads (0.4.34), and the client cache auto-wipes on game exit. - Rewrite the server-config section for the real keys: max_preload_mb (2048), max_cache_mb (750), render_distance_blocks (128), sound_category (record), preload_urls, cache_entries. Co-Authored-By: Claude Opus 4 <noreply@anthropic.com>
This commit is contained in:
86
README.md
86
README.md
@@ -64,7 +64,7 @@ Fabric은 마인크래프트에 모드 기능을 추가해 주는 로더입니
|
|||||||
|
|
||||||
### STEP 5. 잘 설치됐는지 확인
|
### STEP 5. 잘 설치됐는지 확인
|
||||||
|
|
||||||
게임 안에서 채팅창에 `/videostick` 을 입력하세요. 정상이라면:
|
게임 안에서 채팅창에 `/videoStick` 을 입력하세요 (대소문자 구분). 정상이라면:
|
||||||
|
|
||||||
- 인벤토리에 **비디오 스틱** 아이템이 들어옵니다 (보라/검정 missing-texture 가 아니라 작대기 모양 아이콘).
|
- 인벤토리에 **비디오 스틱** 아이템이 들어옵니다 (보라/검정 missing-texture 가 아니라 작대기 모양 아이콘).
|
||||||
- 보라/검정 missing texture 가 나오면 **STEP 4** 에서 이전 버전 jar(`video_player-0.4.0.jar` / `0.4.1.jar` 등)가 mods 폴더에 같이 남아있는 경우입니다. 다 지우고 `0.4.35` 만 남기고 다시 시작하세요. (0.4.1 이하는 Fabric 26.1.2 model 로더가 unprefixed `item/generated` parent 를 거부해서 스틱 아이콘이 missing-model 큐브로 보입니다 — 0.4.2 에서 수정됨.)
|
- 보라/검정 missing texture 가 나오면 **STEP 4** 에서 이전 버전 jar(`video_player-0.4.0.jar` / `0.4.1.jar` 등)가 mods 폴더에 같이 남아있는 경우입니다. 다 지우고 `0.4.35` 만 남기고 다시 시작하세요. (0.4.1 이하는 Fabric 26.1.2 model 로더가 unprefixed `item/generated` parent 를 거부해서 스틱 아이콘이 missing-model 큐브로 보입니다 — 0.4.2 에서 수정됨.)
|
||||||
@@ -93,15 +93,23 @@ Fabric은 마인크래프트에 모드 기능을 추가해 주는 로더입니
|
|||||||
|
|
||||||
### 명령어
|
### 명령어
|
||||||
|
|
||||||
|
명령어 이름은 **대소문자를 구분**합니다 (`/videoStick` 처럼 camelCase).
|
||||||
|
|
||||||
| 명령 | 설명 |
|
| 명령 | 설명 |
|
||||||
| --- | --- |
|
| --- | --- |
|
||||||
| `/videostick` | 비디오 스틱 아이템을 인벤토리에 지급 |
|
| `/videoStick` | 비디오 스틱 아이템을 인벤토리에 지급 (플레이어만) |
|
||||||
| `/videoplace <pos> <facing> <w> <h> <url>` | 좌표에 영상 앵커를 즉시 배치 |
|
| `/videoPlace <pos> <facing> <w> <h> <url-or-name>` | 좌표에 영상 앵커 배치 (볼륨 50%·음소거 해제). `url-or-name` 은 http(s) URL 또는 `/videoCache add` 로 등록한 이름 |
|
||||||
| `/videodelete <pos>` | 좌표의 영상 앵커 제거 |
|
| `/videoPlace <pos> <facing> <w> <h> <volume> <url-or-name>` | 위와 같지만 볼륨 지정: `0`~`100` (%) 또는 `-1`(음소거로 시작) |
|
||||||
| `/videomute <pos> <on\|off>` | 영상의 음소거 켜고/끄기 |
|
| `/videoDelete <pos>` | 좌표의 영상 앵커 제거 |
|
||||||
| `/videopreload <url>` | URL 을 미리 받아 디스크 캐시에 저장 (자세한 내용은 아래) |
|
| `/videoMute <pos> <on\|off>` | 영상의 음소거 켜고/끄기 |
|
||||||
|
| `/videoCache add <name> <url>` | 자주 쓰는 URL 을 이름으로 등록 (서버 config 에 저장, 접속자에게 자동 프리로드) |
|
||||||
|
| `/videoCache list` | 등록된 이름·URL 목록 표시 |
|
||||||
|
| `/videoCache remove <name>` | 등록된 이름 1개 삭제 |
|
||||||
|
| `/videoCache clear` | 등록된 이름 전체 삭제 |
|
||||||
|
|
||||||
`/videoplace`, `/videodelete`, `/videomute`, `/videopreload` 는 기본적으로 OP(권한 레벨 2) 가 필요하므로 **커맨드 블럭에서도 그대로 호출 가능합니다**. 커맨드 블럭은 기본이 권한 레벨 2 라 별도 설정 없이 동작합니다. (0.4.31 부터 커맨드 블럭·콘솔·함수 등 비(非)플레이어 실행자는 `functionPermissionLevel` 게임룰을 건드리지 않아도 호출됩니다.)
|
- `facing` 은 `north/south/east/west/up/down`, `w`·`h` 는 `1`~`32` 블록.
|
||||||
|
- 모든 `/video*` 명령은 기본적으로 OP(권한 레벨 2) 가 필요하므로 **커맨드 블럭·콘솔에서도 그대로 호출 가능합니다**. 커맨드 블럭은 기본이 권한 레벨 2 라 별도 설정 없이 동작합니다. (0.4.31 부터 커맨드 블럭·콘솔·함수 등 비(非)플레이어 실행자는 `functionPermissionLevel` 게임룰을 건드리지 않아도 호출됩니다.)
|
||||||
|
- `/videoStick` 만 플레이어 전용입니다(인벤토리에 아이템을 줘야 하므로).
|
||||||
|
|
||||||
### 소리(오디오) 설정 (0.4.32+)
|
### 소리(오디오) 설정 (0.4.32+)
|
||||||
|
|
||||||
@@ -109,61 +117,61 @@ Fabric은 마인크래프트에 모드 기능을 추가해 주는 로더입니
|
|||||||
|
|
||||||
어떤 슬라이더가 영상 소리를 제어할지는 `config/video_player.json` 의 `sound_category` 로 바꿀 수 있습니다 (클라이언트별 설정). 가능한 값: `master, music, record, weather, block, hostile, neutral, player, ambient, voice, ui`. 기본값은 `record` 이고, 잘못된 값을 적으면 경고 로그를 남기고 `record` 로 동작합니다.
|
어떤 슬라이더가 영상 소리를 제어할지는 `config/video_player.json` 의 `sound_category` 로 바꿀 수 있습니다 (클라이언트별 설정). 가능한 값: `master, music, record, weather, block, hostile, neutral, player, ambient, voice, ui`. 기본값은 `record` 이고, 잘못된 값을 적으면 경고 로그를 남기고 `record` 로 동작합니다.
|
||||||
|
|
||||||
소리 크기는 **판때기 중앙**으로부터의 거리로 감쇠되며(16블록에서 0), `/videomute <pos> <on|off>` 로 개별 영상을 음소거할 수 있습니다.
|
소리 크기는 **판때기 중앙**으로부터의 거리로 감쇠되며(16블록에서 0), `/videoMute <pos> <on|off>` 로 개별 영상을 음소거할 수 있습니다.
|
||||||
|
|
||||||
### `/videopreload` — 영상 미리 로딩 (스터터 제거)
|
### `/videoCache` — 영상 미리 로딩 (스터터 제거)
|
||||||
|
|
||||||
스트리밍 URL 을 라이브로 받으면서 재생하면 네트워크가 잠깐 느려질 때 끊김이 생깁니다. `/videopreload <url>` 을 미리 한번 실행하면 클라이언트가 백그라운드에서 URL 을 통째로 다운로드해서 `.minecraft/video_player_cache/` 폴더에 저장해 두고, 같은 URL 로 영상이 재생될 때 인터넷이 아니라 그 로컬 파일을 사용합니다 (= 끊김 없음).
|
스트리밍 URL 을 라이브로 받으면서 재생하면 네트워크가 잠깐 느려질 때 끊김이 생깁니다. `/videoCache add <name> <url>` 로 URL 을 이름과 함께 등록해 두면, 접속해 있는 모든 클라이언트가 백그라운드에서 그 URL 을 통째로 다운로드해 로컬 캐시에 저장하고, 같은 URL(또는 그 이름)로 영상이 재생될 때 인터넷이 아니라 로컬 파일을 사용합니다 (= 끊김 없음).
|
||||||
|
|
||||||
```
|
```
|
||||||
/videopreload https://video.example.com/foo.mp4
|
/videoCache add intro https://video.example.com/foo.mp4
|
||||||
|
/videoPlace 10 64 10 north 4 3 intro # 등록한 이름을 URL 자리에 그대로 사용
|
||||||
```
|
```
|
||||||
|
|
||||||
특징:
|
특징:
|
||||||
|
|
||||||
- **커맨드 블럭에서 사용 가능** — 예: 압력판 → 커맨드 블럭 `/videopreload <url>` 으로 트리거하면 플레이어가 영상 영역에 다가가기 전에 미리 다운로드 시작
|
- **커맨드 블럭·콘솔에서 사용 가능** — 예: 서버 시작 시 함수로 `/videoCache add ...` 를 등록해 두면 접속자가 영상에 다가가기 전에 미리 다운로드가 시작됩니다
|
||||||
- 명령은 서버에서 실행되지만, 다운로드는 각 **클라이언트**(접속해 있는 모든 플레이어)가 자기 PC 에 받습니다
|
- 명령은 서버에서 실행되지만, 다운로드는 각 **클라이언트**(접속한 모든 플레이어)가 자기 PC 에 받습니다
|
||||||
- 이미 받아둔 URL 은 재요청해도 다시 다운로드 안 함 (URL 의 SHA-256 으로 캐싱)
|
- 등록한 이름은 서버 config(`config/video_player.json` 의 `cache_entries`)에 저장되어 **재시작 후에도 유지**되고, 새로 접속하는 플레이어에게도 자동으로 전달됩니다
|
||||||
- 한 파일당 상한 512 MB
|
- 이미 받아둔 URL 은 재요청해도 다시 다운로드하지 않습니다 (URL 의 SHA-256 으로 캐싱)
|
||||||
- 캐시 폴더가 너무 커지면 직접 `.minecraft/video_player_cache/` 안의 파일을 삭제해도 됩니다 (그러면 다음 사용 시 다시 받아옴)
|
- 한 영상당 / 전체 캐시 용량 상한은 config 의 `max_preload_mb` / `max_cache_mb` 로 정합니다 (아래 참고)
|
||||||
|
- `/videoCache remove <name>` 하면 다운로드 중인 항목까지 취소되고 해당 캐시 파일이 삭제됩니다 (0.4.34)
|
||||||
|
- 클라이언트 캐시는 **게임 종료 시 자동으로 비워집니다**. 등록 항목은 서버에 남아 있으므로 다음 접속 때 다시 받아옵니다 — 캐시 폴더를 수동으로 지울 필요가 없습니다
|
||||||
|
|
||||||
> 영상 삭제 시 소리가 안 멎던 문제는 0.4.4 에서 수정되었습니다 (앵커 블록이 사라지면 디코더 / 오디오 라인을 즉시 강제 종료). 0.4.5 에서는 `BLOCK_ENTITY_UNLOAD` 이벤트가 누락되는 엣지케이스를 대비해 매 틱마다 BE 존재를 한 번 더 검증합니다.
|
> 영상 삭제 시 소리가 안 멎던 문제는 0.4.4 에서 수정되었습니다 (앵커 블록이 사라지면 디코더 / 오디오 라인을 즉시 강제 종료). 0.4.5 에서는 `BLOCK_ENTITY_UNLOAD` 이벤트가 누락되는 엣지케이스를 대비해 매 틱마다 BE 존재를 한 번 더 검증합니다.
|
||||||
|
|
||||||
> 0.4.5 부터 다운로드 시작 / 완료 / 실패가 채팅창에 표시됩니다. 커맨드블럭으로 `/videopreload` 후 `/videoplace` 를 이어 실행할 때는 `[videopreload] 완료` 메시지를 본 뒤에 재생해야 로컬 파일에서 재생됩니다 (그 전에 재생하면 일반 스트리밍으로 떨어집니다).
|
> 다운로드 시작 / 완료 / 실패는 `[videopreload]` 채팅 메시지로 표시됩니다. 커맨드블럭/함수로 `/videoCache add` 후 `/videoPlace` 를 이어 실행할 때는 `[videopreload] 완료` 메시지를 본 뒤에 재생해야 로컬 파일에서 재생됩니다 (그 전에 재생하면 일반 스트리밍으로 떨어집니다).
|
||||||
|
|
||||||
> 0.4.5 부터 오디오 거리 감쇠가 **판때기 중앙**을 기준으로 계산됩니다. 예전엔 앵커 블록(보통 화면 모서리)을 기준으로 측정해서 큰 화면일수록 소리가 한쪽에서 들리는 느낌이었습니다.
|
### 서버 config (`config/video_player.json`)
|
||||||
|
|
||||||
### 서버 config 로 자동 프리로드 (0.4.6+)
|
서버(싱글플레이는 통합 서버)에 모드를 넣고 한 번 실행하면 `config/video_player.json` 이 자동 생성됩니다. 기본 생성 내용:
|
||||||
|
|
||||||
서버에 모드를 넣고 한 번 실행하면 `<서버폴더>/config/video_player.json` 가 자동 생성됩니다. 이 파일에 자주 쓰는 영상 URL 을 적어두면, 플레이어가 접속할 때마다 서버가 자동으로 그 URL 들의 프리로드 요청을 보냅니다 (= `/videopreload` 를 사람마다 친 것과 같음).
|
|
||||||
|
|
||||||
기본 생성된 파일 예시:
|
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"_comment": "preload_urls: HTTP(S) video URLs broadcast to every player on join. ...",
|
"_comment": "max_preload_mb: ... cache_entries: named entries managed by /videoCache add|list|remove.",
|
||||||
"preload_urls": []
|
"max_preload_mb": 2048,
|
||||||
|
"max_cache_mb": 750,
|
||||||
|
"render_distance_blocks": 128,
|
||||||
|
"sound_category": "record",
|
||||||
|
"preload_urls": [],
|
||||||
|
"cache_entries": []
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
사용 예시 — 인트로 영상과 BGM 영상을 모든 접속자가 미리 받도록:
|
키 설명:
|
||||||
|
|
||||||
```json
|
- `max_preload_mb` — 클라이언트가 영상 **한 개**를 받을 때의 상한(MB). 초과하면 그 다운로드를 중단합니다. 기본 2048.
|
||||||
{
|
- `max_cache_mb` — 클라이언트 **전체 캐시 폴더**의 상한(MB). 기본 750.
|
||||||
"preload_urls": [
|
- `render_distance_blocks` — 영상 앵커가 렌더링되는 최대 거리(블록). 기본 128.
|
||||||
"https://video.example.com/intro.mp4",
|
- `sound_category` — 영상 오디오를 어느 음량 슬라이더로 제어할지 (위 "소리 설정" 참고). 기본 `record`.
|
||||||
"https://video.example.com/bgm-loop.webm"
|
- `cache_entries` — `/videoCache add|list|remove` 로 관리되는 **이름 있는** 자동 프리로드 목록. 예: `[{ "name": "intro", "url": "https://video.example.com/intro.mp4" }]`. 직접 편집보다 명령어 사용을 권장합니다(명령어는 즉시 반영·접속자에게 즉시 브로드캐스트).
|
||||||
]
|
- `preload_urls` — 이름 없는 레거시 자동 프리로드 목록(하위호환). 접속 시 모든 플레이어가 받습니다. 각 URL 은 `http(s)://` 시작, 256자 이하.
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
규칙:
|
규칙:
|
||||||
|
|
||||||
- 각 URL 은 `http://` 또는 `https://` 시작, 256자 이하 (그 외는 무시되고 서버 로그에 WARN)
|
- `cache_entries` 는 명령어로 바꾸면 즉시 저장·반영됩니다. `preload_urls` 등 파일을 직접 수정한 경우엔 **서버 재시작** 이 필요합니다(파일은 시작 시 1회 로딩).
|
||||||
- 파일 수정 후 적용하려면 **서버 재시작** 이 필요합니다 (config 는 시작 시 1회만 로딩)
|
- 이미 캐시된 URL 은 다시 다운로드하지 않습니다 (SHA-256 캐시 키).
|
||||||
- 접속한 플레이어 화면에는 `/videopreload` 와 동일한 `[videopreload] 다운로드 시작 / 완료` 채팅 메시지가 보입니다
|
- 싱글플레이도 통합 서버의 `config/video_player.json` 에 동일하게 동작합니다.
|
||||||
- 이미 캐시된 URL 은 다시 다운로드하지 않습니다 (SHA-256 캐시 키)
|
|
||||||
- 싱글플레이는 자체적으로 통합 서버를 띄우므로, 통합 서버의 config 폴더(`<게임폴더>/config/video_player.json`)에도 같은 효과로 동작합니다
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user