kiigame/kged

Document game import/export package structure

Open

#25 opened on Feb 15, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (6 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

The package structure the editor uses for loading and saving projects needs to be defined.

It might be wise to keep the structure closely aligned with how the editor does it so that deploying and running the created games is as simple as possible.

Current package structure:

pelidata.zip ├── images │ └── placeholder │ ├── furniture.png │ ├── item.png │ └── room.png ├── interactions.json ├── items.json ├── rooms.json └── texts.json

Contributor guide

Research direction
Familiarize yourself with the existing package structure in the editor and update the documentation to reflect the current standard.
Tech stack
javascript
Domain
game dev
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90