Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CCSMB-3: bimg File Format #22

Open
wants to merge 13 commits into
base: master
Choose a base branch
from
Open

CCSMB-3: bimg File Format #22

wants to merge 13 commits into from

Conversation

EmmaKnijn
Copy link
Member

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

@EmmaKnijn EmmaKnijn added the classification: proposal Introduction of a new proposal. label Jan 10, 2023
@EmmaKnijn
Copy link
Member Author

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

Standards/CCSMB-3.md Outdated Show resolved Hide resolved
@Erb3
Copy link
Contributor

Erb3 commented Jan 10, 2023

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

@EmmaKnijn EmmaKnijn 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
@EmmaKnijn EmmaKnijn changed the title CCSMB-3: bing File Format CCSMB-3: bimg File Format Jan 10, 2023
Standards/CCSMB-3.md Show resolved Hide resolved
@tomodachi94 tomodachi94 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
Copy link
Member

@tomodachi94 tomodachi94 left a comment

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.

Standards/CCSMB-3.md Outdated Show resolved Hide resolved
Standards/CCSMB-3.md Outdated Show resolved Hide resolved
@tomodachi94 tomodachi94 added the status: stale An unmerged pull request has sat for a month with no comments. label Mar 24, 2024

| 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. |
Copy link
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.

Copy link
Member Author

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
Copy link
Member

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

Standards/CCSMB-3.md Outdated Show resolved Hide resolved
@EmmaKnijn EmmaKnijn marked this pull request as draft March 26, 2024 10:31
@EmmaKnijn EmmaKnijn removed the status: stale An unmerged pull request has sat for a month with no comments. label Mar 26, 2024
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.
Copy link
Member Author

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?

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

Standards/CCSMB-3.md Outdated Show resolved Hide resolved
@EmmaKnijn EmmaKnijn marked this pull request as ready for review March 29, 2024 06:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
classification: proposal Introduction of a new proposal. status: help wanted Extra attention is needed status: work in progress Needs more work before it can be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ToDo: write/copy bimg standard
6 participants