pubg-minimap-replay

이 레포지토리는 정해진 포맷된 데이터를 재생하는 라이브러리입니다.

npm

아직 npm package로 배포되지 않았습니다.

How to use

build

$ npm run build

build를 실행하면 dist폴더에 bundle.js 파일이 생성됩니다.

load script

<script src="bundle.js"></script>

html에서 bundle된 js파일을 불러옵니다.

create minimap

let data = { Formatted Data };
let minimap = new Replay.Minimap(data);

minimap.mount(document.body);

위와 같이 new Replay.Minimap(data)로 미니맵을 생성할 수 있습니다.

Properties

isPlaying

현재 리플레이가 재생 중인 상태이면 true, 중지된 상태이면 false의 값을 가집니다.
이 속성의 값을 변경하는 것으로 미니맵을 재생/중지 시킬 수 있습니다.

currentTime

type: number
default: 0
min: 0
max: duration

현재 미니맵이 표현하고 있는 게임의 시간입니다.

duration (readonly)

type: number
value: (data의 값에 따름)
min: 0

게임의 총 시간입니다.

speed

type: number
default: 10
min: 0

미니맵을 재생할 때 몇 배속으로 재생할지 지정합니다.

center

type: Point
default: { x: gameWidth / 2, y: gameHeight / 2 }

현재 화면 중심 지점에 대한 게임 내에서의 좌표입니다.

method: set(x, y)

center 지점의 x값과 y값을 같이 변경할 수 있는 메소드입니다.

let minimap = new Replay.Minimap(data);
minimap.center.set(minimap.gameWidth / 2, minimap.gameHeight / 2);

event: change

center 지점이 변경되면 호출되는 이벤트입니다.

let minimap = new Replay.Minimap(data);
minimap.center.on('change', () => {
    console.log('center position changed');
});

zoom

type: number
default: 1
min: 1

미니맵을 얼마나 확대했는지 나타냅니다.

width

type: number
default: 800

canvas에 그려지는 미니맵의 가로 크기입니다.

height

type: number
default: 800

canvas에 그려지는 미니맵의 세로 크기입니다.

scaleX (readonly)

type: number
value: width * zoom / gameWidth

게임을 미니맵에 그리기 위해 x축으로 얼마나 축소/확대되었는지 나타냅니다.

scaleY (readonly)

type: number
value: height * zoom / gameHeight

게임을 미니맵에 그리기 위해 y축으로 얼마나 축소/확대되었는지 나타냅니다.

gameWidth (readonly)

type: number
value: (data의 값에 따름)

게임의 맵 가로 크기를 의미합니다.

gameHeight (readonly)

type: number
value: (data의 값에 따름)

게임의 맵 세로 크기를 의미합니다.

canvas (readonly)

type: HTMLCanvasElement

미니맵이 그려지는 <canvas> 요소입니다.

Methods

start()

미니맵을 재생합니다. isPlaying 속성이 true로 변경됩니다.

stop()

미니맵을 중지합니다. isPlaying 속성이 false로 변경됩니다.

mount(element)

미니맵이 그려지는 canvas를 element의 (마지막) 자식 요소로 추가합니다.

Events

아래의 이벤트는 minimap.on('event name', callback); 형태로 이벤트를 받을 수 있습니다.

let data = { ... };
let minimap = new Replay.Minimap(data);

minimap.on('assetsLoaded', () => {
    // All texture loaded
    minimap.mount(document.body);
});

assetsLoaded

data안에 있는 모든 texture가 로드 된 후 호출되는 이벤트입니다.

playStateChange

isPlaying 속성이 변경되면 호출되는 이벤트입니다.

currentTimeChange

currentTime 속성이 변경되면 호출되는 이벤트입니다.

speedChange

speed 속성이 변경되면 호출되는 이벤트입니다.

zoomChange

zoom 속성이 변경되면 호출되는 이벤트입니다.

widthChange

width 속성이 변경되면 호출되는 이벤트입니다.

heightChange

height 속성이 변경되면 호출되는 이벤트입니다.

Data format

Data Types

type	example	description
string	"test"	문자열
integer	123	정수형
number	1.23	실수형
boolean	true	논리형
color	0	0 이상 0xFFFFFF 이하의 정수값입니다.
AssetID	"AssetPath"	문자열로 표현되며 AssetList 안에 Key로 반드시 존재해야 합니다.

ReplayData

리플레이 파일의 전체 구조입니다.

{
    // 이 리플레이에 활용한 Asset의 목록 (배열이 아닌 key-value object 형태)
    "assets": AssetList,
    
    // 게임의 전반적인 정보를 저장
    "game": GameInformation,

    // 플레이어나 중립 몬스터등 살아있는 생명체를 표현
    "characters": [
        GameCharacter,
        GameCharacter,
        GameCharacter,
        ...
    ],
    
    // 미니맵에 표시되는 일반 객체
    "objects": [
        GameObject,
        GameObject,
        GameObject,
        ...
    ],
    
    // 미니맵에 표시할 UI
    "ui": [
        GameUI, 
        GameUI, 
        GameUI,
        ...
    ],

    // 캐릭터들이 공격하는 것을 표현
    "attacks": [
        GameAttack,
        GameAttack,
        GameAttack,
        ...
    ],
}

AssetList

리플레이에 필요한 여러 이미지 에셋들을 담고 있습니다.
이미지 에셋은 웹 경로나 base64로 인코딩된 이미지를 넣을 수 있습니다.

{
    "Asset-ID-1": "Asset1 path",
    "Asset-ID-2": "Asset2 path",
    "Asset-ID-3": "Asset3 path",
    ...
}

GameInformation

게임의 전체적인 정보를 저장하고 있습니다.

{
    // 게임 내에서 맵 가로 크기
    "width": number,

    // 게임 내에서의 맵 세로 크기
    "height": number,

    // 배경에 대한 정보
    "background": {
        // 배경 이미지의 AssetID
        "image": AssetID, 
    },

    // 게임 총 진행 시간 (단위: ms)
    "duration": number
}

GameCharacter

플레이어나 중립 몬스터등 살아있는 생명체를 표현할 때 사용합니다.

{
    // 캐릭터를 구분할 아이디
    "id": string,

    // 캐릭터가 표시될 이름, 마우스를 올리면 툴팁으로 이름이 표시됩니다.
    "name": string,

    // 시간에 따른 캐릭터 위치 정보
    "locations": [ 
        LiveGameLocation,
        LiveGameLocation,
        LiveGameLocation,
        ...
    ],

    // 시간에 따른 캐릭터 모양 정보
    "shapes": [
        LiveShape,
        LiveShape,
        LiveShape,
        ...
    ]
}

GameObject

미니맵에 표시되는 일반 객체입니다.
배틀그라운드의 레드존, 자기장(파란 원), 안전 지역(흰색 원), 보급상자 등을 표시할 때 활용 할 수 있습니다.

{
    // 시간에 따른 객체 위치 정보
    "locations": [
        LiveGameLocation,
        LiveGameLocation,
        LiveGameLocation,
        ...
    ],

    // 시간에 따른 객체 모양 정보
    "shapes": [
        LiveShape,
        LiveShape,
        LiveShape,
        ...
    ],

    // 객체에 마우스 오버시 툴팁으로 표시할 내용 (해당 객체 클릭시 툴팁이 고정됨)
    "tooltips": [
        LiveTooltip,
        LiveTooltip,
        LiveTooltip,
        ...
    ],
}

GameUI

미니맵에 표시할 UI를 정의합니다.
배틀 그라운드의 살아있는 사람 수, 혹은 리그오브레전드의 킬 스코어 현황 등을 표시할 때 활용 할 수 있습니다.

{
    // 시간에 따른 UI의 위치
    "positions": [
        LivePosition,
        LivePosition,
        LivePosition,
        ...
    ],

    // 시간에 따른 UI의 모양
    "shapes": [
        LiveShape,
        LiveShape,
        LiveShape,
        ...
    ],

    // 시간에 따른 UI 내 글씨
    "texts": [
        LiveText,
        LiveText,
        LiveText,
        ...
    ],
}

GameAttack

캐릭터들이 공격하는 것을 표현합니다.

LineAttack | BulletAttack

LineAttack

공격 시작 지점에서 공격 대상 지점으로 선 모양으로 그려지는 공격입니다.

{
    // 선 모양 Attack
    "type": "line",

    // 공격 시작 지점
    "attacker": GameLocation,

    // 공격 대상 지점
    "target": GameLocation,

    // 공격 선 모양 정의
    "shape": {
        // 선 두께
        "lineWidth": number,

        // 선 색상
        "lineColor": color,

        // 선 
        "lineAlpha": number,
    },
    // 공격이 진행되는 시간 (단위: 게임 내의 시간 ms)
    "duration": number,

    // 위 duration을 게임 내의 시간이 아닌 리플레이 시 보여지는 시간으로 사용
    "fixDuration": boolean,

    // 현재 정보에 해당하는 게임 시간 (단위: ms) 
    "elapsedTime": number
}

BulletAttack

{
    // 총알 형태 Attack
    "type": "bullet",

    // 공격 시작 지점
    "attacker": GameLocation,

    // 공격 대상 지점
    "target": GameLocation,

    // 총알 모양 정의
    "shape": Shape,

    // 공격이 진행되는 시간 (단위: 게임 내의 시간 ms)
    "duration": number,

    // 위 duration을 게임 내의 시간이 아닌 리플레이 시 보여지는 시간으로 사용
    "fixDuration": boolean,

    // 현재 정보에 해당하는 게임 시간 (단위: ms) 
    "elapsedTime": number
}

LiveGameLocation

게임 시간, 보간 정보를 포함한 게임 맵 기준 좌표 정보입니다.

{
    // 게임을 시작한지 elapsedTime만큼 지났을 때의 좌표
    ...GameLocation,

    // 이전 좌표와 현재 좌표 사이의 좌표를 보간해서 사용 할 지 여부
    "transition": boolean,

    // 현재 좌표에 해당하는 게임 시간 (단위: ms) 
    "elapsedTime": number
}

GameLocation

게임 맵 크기를 기준으로 한 특정 좌표를 의미합니다.

{
    // 게임 맵 크기 기준 x좌표
    "x": number,

    // 게임 맵 크기 기준 y좌표
    "y": number 
}

LivePosition

게임 시간, 보간 정보를 포함한 캔버스 기준 좌표 정보입니다.

{
    // 게임을 시작한지 elapsedTime만큼 지났을 때의 좌표
    ...Position,

    // 이전 좌표와 현재 좌표 사이의 좌표를 보간해서 사용 할 지 여부
    "transition": boolean,

    // 현재 좌표에 해당하는 게임 시간 (단위: ms) 
    "elapsedTime": number
}

Position

캔버스 크기를 기준으로 한 특정 좌표를 의미합니다.

{
    // 캔버스 크기 기준 x좌표
    "x": number,

    // 캔버스 크기 기준 y좌표
    "y": number
}

LiveTooltip

게임 시간을 포함한 툴팁 정보입니다.

{
    // 툴팁으로 표시할 글씨
    "text": string,
    
    // 현재 툴팁에 해당하는 게임 시간 (단위: ms)
    "elapsedTime": number, 
}

LiveText

게임 시간을 포함한 글씨 정보입니다.

{
    // 글씨 내용
    "text": string,

    // 글씨 색
    "textColor": color,

    // 글씨 투명도
    "textAlpha": number,

    // 글씨 크기
    "textSize": number,

    // 현재 글씨에 해당하는 게임 시간 (단위: ms)
    "elapsedTime": number,
}

LiveShape

게임 시간, 보간 정보를 포함한 모양 정보입니다.

{
    // 게임을 시작한지 elapsedTime만큼 지났을 때의 캐릭터 모양 정보
    ...Shape,

    // 이전 모양 정보와 현재 모양 정보 사이의 모양를 보간해서 사용 할 지 여부
    // - 서로 다른 Shape 사이에서는 보간이 되지 않음
    // - Shape의 fillColor, lineColor는 보간이 되지 않음
    "transition": boolean,

    // 현재 모양 정보에 해당하는 게임 시간 (단위: ms)
    "elapsedTime": number   
}

Shape

RectangleShape | EllipseShape | ImageShape

RectangleShape

직사각형 형태의 Shape입니다.

{
    // 직사각형 모양 Shape
    "type": "rectangle",

    // 가로 크기 (게임 맵 크기 기준)
    "width": number,

    // 세로 크기 (게임 맵 크기 기준)
    "height": number,

    // width과 height를 게임 맵 크기 기준이 아닌 캔버스 크기를 기준으로 사용
    "fixSize": boolean,

    // 배경 색상
    "fillColor": color, 

    // 배경 투명도
    "fillAlpha": number, 

    // 테두리 색상
    "lineColor": color, 

    // 테두리 투명도
    "lineAlpha": number,

    // 테두리 두께
    "lineWidth": number,
}

EllipseShape

타원 형태의 Shape입니다.

{
    // 타원 모양 Shape
    "type": "ellipse",

    // 가로 크기
    "width": number, 

    // 세로 크기
    "height": number, 

    // width과 height를 게임 맵 크기 기준이 아닌 캔버스 크기를 기준으로 사용
    "fixSize": boolean, 

    // 배경 색상
    "fillColor": color, 

    // 배경 투명도
    "fillAlpha": number, 

    // 테두리 색상
    "lineColor": color, 

    // 테두리 투명도
    "lineAlpha": number, 

    // 테두리 두께
    "lineWidth": number, 
}

ImageShape

이미지 Asset을 활용한 Shape입니다.

{
    // 이미지 모양 Shape
    "type": "image", 

    // 가로 크기
    "width": number, 

    // 세로 크기
    "height": number, 

    // width과 height를 게임 맵 크기 기준이 아닌 캔버스 크기를 기준으로 사용
    "fixSize": boolean, 

    // 사용할 이미지의 AssetID
    “image": AssetID, 
}

pubg-minimap-replay pubg-minimap-replay copied to clipboard

Metadata