https://github.com/game4all/gamebosu

🕹 A custom ruleset for osu!lazer that adds a playable gameboy.
https://github.com/game4all/gamebosu

gameboy gameboy-emulator osu osu-framework osu-ruleset osugame useless

Last synced: 10 days ago
JSON representation

🕹 A custom ruleset for osu!lazer that adds a playable gameboy.

• Host: GitHub
• URL: https://github.com/game4all/gamebosu
• Owner: Game4all
• License: gpl-3.0
• Created: 2020-04-20T14:24:34.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-09-30T09:36:13.000Z (4 months ago)
• Last Synced: 2025-01-17T02:07:59.796Z (18 days ago)
• Topics: gameboy, gameboy-emulator, osu, osu-framework, osu-ruleset, osugame, useless
• Language: C#
• Homepage:
• Size: 2.72 MB
• Stars: 64
• Watchers: 4
• Forks: 3
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        










A ruleset that adds a playable gameboy to osu!lazer.



# **DISCLAIMER**

This ruleset isn't a serious ruleset and doesn't serve any other purpose than showing the capabilities of the game framework and being cool, and of course useless. Now you're warned ...

## Screenshots

![rom selection](assets/screenshot_selection.png) | ![gameplay](assets/screenshot_gameplay.png)| ![gameplay2](assets/screenshot_gameplay2.png)

|--| --| -- |

# Installation 

The ruleset consists of a single DLL file that you'll have to drop in the `rulesets` directory of your osu!lazer data directory.

Prebuilt releases are available if you do not have an development environement setup in place:

| [Releases](https://github.com/Game4all/gamebosu/releases) | [Latest Release](https://github.com/Game4all/gamebosu/releases/latest)

|--------|--------|

Or you can alternatively build the ruleset yourself by issuing the following commands in your OS shell (_this assumes you've got the .NET Core SDK tools as well as git in your PATH_):

## Building instructions

```bash

    git clone https://github.com/Game4all/gamebosu

    cd gamebosu

    cd osu.Game.Rulesets.Gamebosu

    dotnet build -c:Release # make sure to build ruleset in release mode to create a single file assembly

    # You should find the compiled and packed ruleset assembly in the output directory at path bin/Release/netstandard2.1/osu.Game.Rulesets.Gamebosu.dll 

```

For building this from an IDE, you should open the solution file with your prefered C# editor and hit `build` with the `Release` configuration (in order to create a single file assembly).

## Installation instructions

1. Navigate to your osu!lazer data directory. You can do so by opening the settings panel in osu!lazer and clicking on the "open osu! folder" button. Alternatively you can directly navigate to the rulesets directory via your OS directory explorer at the following locations:

   * `%AppData%/osu/rulesets` on Windows

   * `~/.local/share/osu/rulesets` on Linux / mac OSX

**NOTE:** If you have relocated your osu! data directory to another directory, the rulesets directory will be there instead.

2. Drag and drop the ruleset's DLL file into the `rulesets` directory.

3. Have fun! You may need to head periodically to the releases page to download the latest version of the ruleset as compatibilty may break with a new lazer update. You may want to also read [**Installing Roms**](#Installing-Roms) section before using the ruleset.

# Installing Roms

In order for the ruleset to correctly work, you'll need to download original gameboy or gameboy color ROM files and place them in a `roms` directory inside your osu!lazer data directory (you may have to launch the ruleset once in order for the directory to appear.)

# Acknowledgements

This ruleset uses [Emux](https://github.com/Washi1337/Emux) by _Washi1337_ as its emulation core.

Original idea of running a gameboy emulator on o!f : [osu-GameBoy](https://github.com/osu-Karaoke/osu-GameBoy)