Skip to main content
Deno 2 is finally here 🎉️
Learn more

Beat Saber Deno

General-purpose Beat Saber scripting library using Deno TypeScript, complete with type-check, auto-completion, and suggestions.

Features

  • Zero-dependency: No external library used and no bloated file in the working folder.
  • Mod Compatible: Chroma, Noodle Extensions, and Mapping Extensions is supported out of the box.
  • Modularity: All types, classes and functions are exposed allowing extendability for more functionality.
  • Partial Creation: Define notes, obstacles, events, event boxes partially and let default fill the rest of fields.

Prerequisite

  • Deno 1.21.0 or latest
  • Basic JavaScript or TypeScript knowledge
    • Library is entirely TypeScript, but for common use case you do not need in-depth knowledge.

Getting Started

To get started, check out the example folder for templates you can use. Deno by nature caches the module upon first execution, and will never be updated after. This mean you can continue working on the script regardless of connection and will not break the existing code regardless of newly released update until explicitly updating it via --reload flag or URL version change.

The bare minimum example:

import * as bsmap from 'https://deno.land/x/bsmap/mod.ts';

const data = bsmap.load.difficultySync('ExpertPlusStandard.dat', 3);
bsmap.save.difficultySync(data);

NOTE: Recommended to use https://deno.land/x/bsmap@version/mod.ts to lock version to ensure the script works without breaking from newer update.

You may also clone the library and import it locally to make any modification as you wish.

If you are using the script outside of map directory, you can specify the map directory without the need to explicitly apply path on IO function. This can be any valid path as long as it points to directory.

bsmap.globals.path = '/PATH/TO/YOUR/BEAT_SABER/MAP_FOLDER/';

Usage

Run the script by running this command in terminal deno run yourscriptpath.ts. For more advanced use, you may do deno run --allow-read --allow-write --watch yourscriptpath.ts. If you want to update to newer version, simply run deno run --reload yourscriptpath.ts; Do note that it may break existing part of your code that utilises the library.

For further explanation over on Deno Manual.

Deno related: if you are having issue of not being able to retrieve module on import, then reload or cache the module to fix it. To reload or cache the module, run deno cache --reload yourscriptpath.ts and restart Deno server if necessary. If it still does not work, change to a different workspace.

Contributing

If you wish to contribute, do follow the guidelines. Make pull request for feature addition/enhancement/fix or create an issue if you encounter error/problem or want an improvement.

Guidelines

  • Use deno fmt for standard formatting.
  • File names shall use camel case.
  • Exported types, interfaces, fields, and functions should accompany with JSDoc comment right above its definition.
  • No third-party dependencies shall be used outside of examples, extensions, and tests.
  • Avoid circular imports.

Planned

  • Strip some of the features as plugin/extension allowing for modular and lightweight system
  • Add more helper for Chroma and Noodle Extensions
  • Overload function for less function clutter (but more complex)
  • Make top-level function a regular function instead of arrow function
  • Bundle script