Lantern · 게임 라이브러리 서버를 위한 개방형 프로토콜

초안 0.2

1.0 전까지 본문은 바뀔 수 있습니다. 특히 클라이언트와 서버 작성자의 의견을 환영합니다.

오래 가도록

탄탄한 이유

Lantern은 처음부터 새로 시작합니다. 이전의 어떤 프로토콜과도 호환되지 않으므로, 모든 선택이 안전과 오래 쓰는 것을 위한 것입니다.

경로와 모든 문서, 두 곳에서 버전을 관리합니다. 변경이 클라이언트를 조용히 망가뜨리는 일은 없습니다.
기기마다 토큰 하나, 서버에서 승인하고 하나씩 취소할 수 있습니다. 콘솔에서 비밀번호를 입력하거나 저장하는 일은 없습니다.
어디서나 HTTPS. 자체 인증서를 쓰는 집 서버는 두 화면에서 키 지문을 비교한 뒤 페어링할 때 고정됩니다.
검증된 콘텐츠. 모든 파일에 SHA-256이 있고, 콘솔은 설치하기 전에 이를 확인합니다.
선언된 기능. 서버는 무엇을, 누구에게, 어떤 스키마로 제공하는지 밝힙니다.
서버를 밖에서 확인하는 적합성 테스트 모음과, 이를 통과하는 참조 서버.

새로운 것

더하는 것

지금까지 클라이언트가 짐작해야 했던 것을 글로 적었습니다.

모든 파일에 SHA-256. 설치하기 전에 확인합니다.
경로에 버전, 모든 문서에 schema. 나이가 다른 클라이언트와 서버도 계속 함께 작동합니다.
짐작이 아니라 선언된 기능 목록.
라이브러리가 바뀌어도 건너뛰거나 반복하지 않는 커서 페이지.
콘솔에 비밀번호를 두지 않고, 취소할 수 있는 토큰으로 페어링.
진짜 상태 코드를 가진 오류를 하나의 형식으로.
숨기는 것 없음. 하드웨어 식별자도, 독점 암호화도, 서버가 정하는 클라이언트 변경도 없습니다.

구현하기

서버와 클라이언트 작성자를 위해

명세는 짧습니다. 적은 경로, 정해진 형태, 단순한 HTTP와 JSON.

서버 작성하기

핸드셰이크와 라이브러리를 제공하고, 세이브 백업, 치트, 페어링은 원할 때 더해 기능으로 선언하세요. 서버는 주말 하루면 됩니다.

GET /.well-known/lantern
GET /api/lantern/v1/apps?sort=added

클라이언트 작성하기

로컬 네트워크에서 서버를 찾고, 기능을 읽고, 라이브러리를 페이지별로 훑고, 다운로드마다 SHA-256을 확인하세요. 클라이언트는 C++ 몇백 줄이면 됩니다.

User-Agent: ExampleClient/0.1
Range: bytes=0-1048575

스키마와 예시

모든 문서의 JSON 스키마, 각각의 예시, 경로의 OpenAPI 설명. 자신의 구현을 맞춰 볼 수 있습니다.

schemas/v1 · examples/v1 · openapi.yaml

저장소에는 서버에 대고 돌리는 적합성 테스트 모음(conformance/)과 이를 통과하는 작은 참조 서버(server/)가 있습니다. 이 테스트를 통과한 구현만 Lantern 호환이라고 해야 합니다.

첫 클라이언트는 Nintendo Switch용 홈브류 패키지 관리자 PlayShelf입니다. PlayShelf

내 게임을 위해

Lantern은 내 서버에 있는 것을 서버와 콘솔 사이에서 나를 뿐입니다. 아무것도 찾지 않고 배포하지도 않습니다. 게임을 얻는 수단이 아니며, 서버는 내가 가진 게임을 위한 것입니다.

라이선스

자유롭게 구현하세요

CC BY 4.0명세 본문. 출처를 밝히면 공유하고 고칠 수 있습니다.
MIT나머지 모두(스키마, OpenAPI 설명, 예시, 적합성 테스트, 참조 서버). 어떤 라이선스의 서버나 클라이언트든 프로토콜을 구현하고 스키마를 그대로 가져갈 수 있습니다.

질문, 의견, 제안은 저장소의 이슈로 보내 주세요.

이 사이트

개인정보

이 사이트는 쿠키를 사용하지 않으며, 브라우저에는 헤더에서 고른 언어만 저장합니다. 다른 사이트에서 아무것도 불러오지 않습니다. 글꼴, 이미지, 스크립트는 모두 이 사이트에서 제공됩니다.

방문은 유럽 연합(프랑크푸르트)의 Umami Cloud로 쿠키 없이 집계합니다. 조회된 페이지마다 해당 페이지, 이전 페이지, 브라우저, 시스템, 기기 종류, 화면 크기, 언어, 국가를 기록합니다. IP 주소는 국가를 파악하고 방문을 구분하는 데 쓰이며, 방문 기록과 함께 보관되지 않습니다. 집계는 6개월간 보관되고, 무엇이 읽히는지 아는 데만 쓰이며, 판매하거나 공유하지 않습니다. Umami의 정책: umami.is/privacy.

이 사이트를 발행하는 곳, 호스팅하는 곳, 내 데이터에 대해 묻는 방법: 개인정보 및 법적 고지

읽고 나서 알려 주세요

초안일 때가 바꿀 때입니다. 경로, 필드, 빠진 경우에 관한 이슈 하나가 앞으로의 모든 서버와 클라이언트를 돕습니다.

명세 읽기 이슈 열기

서버에서 콘솔까지, 하나의 개방형 프로토콜.