Skip to content

CCSMB-3: bimg File Format - #22

Open
EmmaKnijn wants to merge 13 commits into
CCSMB:masterfrom
EmmaKnijn:bimg
Open

CCSMB-3: bimg File Format#22
EmmaKnijn wants to merge 13 commits into
CCSMB:masterfrom
EmmaKnijn:bimg

Conversation

@EmmaKnijn

@EmmaKnijnEmmaKnijn commented Jan 10, 2023

Copy link
Copy Markdown
Member

Here's a first copy and header change for bimg, this would close#19

@EmmaKnijnEmmaKnijn added the classification: proposal Introduction of a new proposal. label Jan 10, 2023
@EmmaKnijn

EmmaKnijn commented Jan 10, 2023

Copy link
Copy Markdown
MemberAuthor

Note that I'm unsure if CCSMB-3 was already reserved but I saw we jumped from 2 to 4

piprett
piprett suggested changes Jan 10, 2023
View reviewed changes
Comment threadStandards/CCSMB-3.md Outdated
@piprett

piprett commented Jan 10, 2023•
edited
Loading

Copy link
Copy Markdown
Contributor

If you are planning to edit more stuff, please make this a draft. Currently it looks like it a proposal

@EmmaKnijnEmmaKnijn added the status: help wanted Extra attention is needed label Jan 10, 2023
@EmmaKnijn
EmmaKnijn marked this pull request as draft January 10, 2023 15:33
@EmmaKnijnEmmaKnijn changed the title CCSMB-3: bing File FormatCCSMB-3: bimg File FormatJan 10, 2023
spr2-dev
spr2-dev requested changes Jan 15, 2023
View reviewed changes
Comment threadStandards/CCSMB-3.md
@tomodachi94tomodachi94 added the status: work in progress Needs more work before it can be merged. label Feb 28, 2023
@EmmaKnijn
EmmaKnijn marked this pull request as ready for review July 29, 2023 11:13
tomodachi94
tomodachi94 requested changes Jul 29, 2023
View reviewed changes

@tomodachi94tomodachi94 left a comment •
edited
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good; see my requested changes.

Also, a few notes:

  1. We should refer to "bimg renderers (must|should|may)" instead of just "bimg". (See also my third point.)
  2. We should avoid embedding images unless necessary, preferring code blocks to screenshots of images.
  3. We should use RFC 2119 phrases (MUST, SHOULD, MAY, etc) instead of phrases like "can".

Otherwise, this proposal is extremely well-written.

Comment threadStandards/CCSMB-3.md Outdated
Comment threadStandards/CCSMB-3.md Outdated
@EmmaKnijn@tomodachi94
Update Standards/CCSMB-3.md
2926a43
Co-authored-by: Tomo <68489118+tomodachi94@users.noreply.github.com>
@tomodachi94tomodachi94 added the status: stale An unmerged pull request has sat for a month with no comments. label Mar 24, 2024
tomodachi94
tomodachi94 reviewed Mar 24, 2024
View reviewed changes
Comment threadStandards/CCSMB-3.md

| Field | Type | Description |
|:--|:-:|:--|
| `version` | `string` | Format version of the file. Used to differentiate two bimg file formats. Composed of three numbers separated by dots, defining the major, minor, and revision number respectively. |

@tomodachi94tomodachi94Mar 24, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice if this value included the string "BIMG", so that the file format can be determined immediately without needing to probe the rest of the file.

@EmmaKnijnEmmaKnijnMar 26, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think this should be a seperate field, to ensure backwards compatibility

@tomodachi94

tomodachi94 commented Mar 24, 2024

Copy link
Copy Markdown
Member

Make sure to define a file extension, perhaps .bimg, that the format should use.

DVD-DAVIDE
DVD-DAVIDE reviewed Mar 25, 2024
View reviewed changes
Comment threadStandards/CCSMB-3.md Outdated
@EmmaKnijn
EmmaKnijn marked this pull request as draft March 26, 2024 10:31
@EmmaKnijnEmmaKnijn removed the status: stale An unmerged pull request has sat for a month with no comments. label Mar 26, 2024
EmmaKnijn
EmmaKnijn commented Mar 26, 2024
View reviewed changes
Comment threadStandards/CCSMB-3.md
For animation support, see [Animations](#animations).

## Frame Structure
A single frame MUST be composed of multiple numerically-indexed tables, each representing a single line of the image.

@EmmaKnijnEmmaKnijnMar 26, 2024

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this be multiple or at least one?

@DVD-DAVIDEDVD-DAVIDEMar 26, 2024

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say at least one

piprett
piprett reviewed Mar 26, 2024
View reviewed changes
Comment threadStandards/CCSMB-3.md Outdated
@EmmaKnijn
EmmaKnijn marked this pull request as ready for review March 29, 2024 06:12
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@SkyTheCodeMasterSkyTheCodeMasterSkyTheCodeMaster left review comments
@DVD-DAVIDEDVD-DAVIDEDVD-DAVIDE left review comments
@tomodachi94tomodachi94tomodachi94 requested changes
@spr2-devspr2-devspr2-dev requested changes
+1 more reviewer
@piprettpiprettpiprett requested changes
Reviewers whose approvals may not affect merge requirements

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

classification: proposalIntroduction of a new proposal.status: help wantedExtra attention is neededstatus: work in progressNeeds more work before it can be merged.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

ToDo: write/copy bimg standard

6 participants

@EmmaKnijn@piprett@tomodachi94@SkyTheCodeMaster@DVD-DAVIDE@spr2-dev