bemusic/bemuse-tools

Tools for Bemuse server authors

bemuse-tools's Issues

Turn to Mocha + Chai

As with the bemuse project.

BEMUSEPACK 2.0

Revamp the format. Totally breaks the older version. It's good that 1.0 has never been used.

BEMUSEPACK

A .bemuse file contains

• an arbitrary metadata
• an opaque payload

Usually, the metadata describes what's inside the payload.

File Format

• 10 bytes magic string BEMUSEPACK
• 4 bytes Uint32LE — metadata size N (may be 0 if no metadata)
• N bytes — metadata
• the rest of the file — payload

Metadata

An entry file should have a metadata of more than 0 bytes. It should be a valid JSON. It describe all files both internal and external. External packages should have metadata of 0 bytes.

{
  version: 2,
  song: { title, artist, genre, ... },
  refs: [
    { size, hash }, // the first ref (0) describes its own payload
    { path, size, hash }, // ref 1's payload metadata
    ...
  ],
  files: [
    {
      name, type, size, hash,
      refs: [
        { [ ref, start, end ], ... }, // start, end relative to payload
        ...
      ]
    }
  ]
}

Allow asset splitting to be turned on/off

Should be off by default.

Display progress bar instead

Since we want to include song metadata into the BEMUSE file, the metadata being written should be visible.

Right now, the STDOUT is overwhelmed by log messages. We should turn that into a progress bar instead.

Wireframe design for Game UI

Mode	Object Ratio
BMS	30:17:13
PMS	17:13

Playable area aspect ratio: 9:20

Only pack assets in bemuse archive, restructure

After much consideration, finally I feel that it's better to only pack assets (keysounds and BGA) into the bemuse pack.

Things that change often VS things that don't

It is planned that .bemuse files will be cached long-term, so we should put things that don't change often here.

• Things that may change
  • List of BMS files
    • new levels, sabuns, note updates and fixes
  • Metadata
    • correction to artist names and profiles
    • updates to README text
• Things that don't change often
  • Keysound files
  • BGA files

New folder and file structure

• [song name]/
  • normal.bms
  • hyper.bms
  • another.bms
  • …
  • sabun_title.bms
  • …
  • assets/
    • metadata.json — same as in BEMUSEPACK v2
    • sound.part1.[hash].bemuse
    • sound.part2.[hash].bemuse
    • …
    • bga.part1.[hash].bemuse
    • bga.part2.[hash].bemuse
    • …

BEMUSEPACK v3

Folder-based approach. All metadata is stored in metadata.json, so no more need for metadata chunk.

• 10 bytes magic string BEMUSEPACK
• the rest of the file — payload

Add david-dm to README badges.

Add README.md into metadata.

Write song metadata into the entry file.

Maybe use command line flags: --title Reminiscentia --artist flicknote.

Include hash inside bemusepack

This is to allow referencing BMS files based on object hash. We can also checksum the payload.

Make bemuse-tools support bmson

Detect song metadata from the BMS files.

Signify which file is an entry file.

By signifying which file is the entry file, we can allow dragging multiple files into the web and have dependencies resolved!

Update README because it’s utterly outdated…………………