https://github.com/silvncr/osutool

wip multipurpose tool for osu! files
https://github.com/silvncr/osutool

osugame python-library

Last synced: 2 months ago
JSON representation

wip multipurpose tool for osu! files

• Host: GitHub
• URL: https://github.com/silvncr/osutool
• Owner: silvncr
• License: mit
• Created: 2024-05-20T09:20:25.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-07T05:14:20.000Z (almost 2 years ago)
• Last Synced: 2025-09-28T23:16:50.382Z (8 months ago)
• Topics: osugame, python-library
• Language: Python
• Homepage: https://pypi.org/project/osutool
• Size: 17.6 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          

# osutool

multipurpose tool for *osu!* files

![version](https://img.shields.io/pypi/v/osutool)

![status](https://img.shields.io/github/actions/workflow/status/silvncr/osutool/python-publish.yml)

![downloads](https://img.shields.io/pypi/dm/osutool)

![license](https://img.shields.io/github/license/silvncr/osutool)

![python](https://img.shields.io/pypi/pyversions/osutool)

## Summary

Provides utility for compiling and extracting *osu!*-related filetypes.

- :snake: Supports Python 3.8 and above. Tested on Windows 10.

- :construction: Work in progress. Features are not finalised and may be unstable.

- :arrows_clockwise: Pull requests are welcome!

- :star: Show your support by leaving a star!

> osutool is not affiliated with *osu!*. For official information about *osu!*, visit [osu.ppy.sh](https://osu.ppy.sh).

## Contents

- [Summary](#summary)

- [Contents](#contents)

- [Features](#features)

- [Installation](#installation)

- [Usage](#usage)

  - [Compilation (folders to files)](#compilation-folders-to-files)

  - [Extraction (files to folders)](#extraction-files-to-folders)

## Features

- [x] convert beatmap/song folders to `.osz` files, and vice versa

- [ ] convert skin folders to `.osk` files, and vice versa

## Installation

```sh

python -m pip install --upgrade osutool

```

## Usage

Open a command line from the directory with the files you want to manipulate, then run osutool.

```sh

$ osutool

 [NOTICE]  | Mode is not set.

 [INPUT]   | Set mode to [c]ompile or [e]xtract. > _

```

### Compilation (folders to files)

```sh

> c

```

The program will create a file for every applicable folder and subfolder. Files generated from subfolders will be placed in the same subfolder.

Each file will be named after the folder it was created from.

### Extraction (files to folders)

```sh

> e

```

The program will generate a folder for every file in the current folder and its subfolders. Folders generated from subfolders will be placed in the same subfolder.

Each folder will be named after the file it was created from.