mirror of
https://github.com/cellos51/balatro-gba.git
synced 2026-03-21 17:55:44 -05:00
461584b674
* Music - Added portamento and note stops to the lead melody
* Added OpenMPT .bak files to .gitignore
* Music - Expanded the module 2x for more accurate quasi-triplet + added 2-3 measures
* Music - Added pitch bend and fixed decorative note
* Music - Added measures 31-32
* Fixed wrong G/D chord sample
* Music - added measures 37-38
* Music - Added echo quasi-square
* Music - layered the quasi-square with the keyboard
* Music - small reduction to quasi-square volume
* Music - more volume adjustments
* Music - added measures 39-32 (triad chords)
* Music - raised the triad chords one octave
* Added missing repetition measures 33-36
* Music - More repetition measures 43-46
* Music - fixed pitch bend in measure 30
* Music - Added tremolo to the lead synth
* Revert "Music - Added tremolo to the lead synth"
This reverts commit 3ffee46845.
* Music - reduced the triad chords by an octave
* Music - Added lead melody fade-out and reduced triad chords volume
* Music - Added channel 7, and unused channel 8
* Increased the triad chords volume back
* Music - Added panned backing chords (used all 8 channels)
* Music - Added all the panned backing chords
* Music - fixed last echo note
* Music - Added background fifth drown to triad chords
* Music - reduced panning of panned chords
* Updated music arrangement credits in README
168 lines
11 KiB
Markdown
168 lines
11 KiB
Markdown
# Balatro-GBA
|
|
|
|
[](https://github.com/cellos51/balatro-gba/actions)
|
|
[](https://github.com/cellos51/balatro-gba/issues)
|
|
[](https://github.com/cellos51/balatro-gba/pulls)
|
|
[](https://github.com/cellos51/balatro-gba/discussions)
|
|
|
|
### Disclaimer
|
|
|
|
This project is a non-profit fan demake of Balatro for the Game Boy Advance, meant to recreate it as accurately as possible including all the visuals that make it satisfying to play. It is **not affiliated with or endorsed by Playstack or LocalThunk** and **it is not to be sold**. This version is a **minimal tech-demo**, intended for those who already own and know the official game. Refer to the Balatro wiki below for descriptions of game mechanics and joker effects. All rights remain with the original holders.
|
|
|
|
<a href="https://balatrowiki.org/">
|
|
<img src="https://custom-icon-badges.demolab.com/badge/Balatro%20Wiki-194c84?logo=bigjoker&logoColor=fff" alt="Balatro Wiki" width="155">
|
|
</a>
|
|
|
|
### Please buy the official full version from these sources below:
|
|
|
|
[](https://store.steampowered.com/app/2379780/Balatro/)
|
|
[](https://play.google.com/store/apps/details?id=com.playstack.balatro.android)
|
|
[](https://apps.apple.com/us/app/balatro/id6502453075)
|
|
[](https://www.nintendo.com/us/store/products/balatro-switch/)
|
|
[](https://store.playstation.com/en-us/concept/10010334)
|
|
[](https://www.xbox.com/en-US/games/store/balatro/9PK087LNGJC5)
|
|
[](https://www.humblebundle.com/store/balatro?srsltid=AfmBOoqS2De8T4kizzWxJS1pbvQosJ_bYCl4qvC6LA1YLPAh4sZ8vJqO)
|
|
|
|
---
|
|
|
|
<a href="https://github.com/cellos51/balatro-gba/releases/">
|
|
<img src="https://img.shields.io/badge/Download_ROMs_from_the_Releases_tab-8A2BE2?&logo=github" alt="Download ROM" width="500">
|
|
</a>
|
|
|
|
---
|
|
|
|
|
|
https://github.com/user-attachments/assets/54a9e2e9-1a02-48d5-bb9d-5ab257a7e03b
|
|
|
|
|
|
### Controls:
|
|
(D-Pad: Navigation)
|
|
|
|
(A: Pick Card/Make Selections)
|
|
|
|
#### When on the hand row during round
|
|
(L: Play Hand)
|
|
|
|
(R: Discard Hand)
|
|
|
|
(B: Deselect All Cards)
|
|
|
|
#### When on the joker row in the shop or during round
|
|
(L: Sell Joker)
|
|
|
|
(Hold A: Swap Owned Jokers or Playing Cards in the Shop or Round)
|
|
|
|
# Contributing
|
|
|
|
If you would like to contribute, please read CONTRIBUTING.md.
|
|
|
|
# **Build Instructions:**
|
|
|
|
## **-Docker-**
|
|
A docker compose file is provided to build this project. It provides a standard build environment for this projects CI/CD and can also be used to build the ROM locally.
|
|
|
|
_Some users may find this option to be the easiest way to build locally._
|
|
- _This option **avoids** setting up the development environment as described below._
|
|
- _No additional software besides **docker desktop** is required._
|
|
|
|
### Step-by-Step
|
|
|
|
1.) Install [docker desktop](https://docs.docker.com/desktop/) for your operating system.
|
|
|
|
2.) Open a terminal to this project's directory:
|
|
- On **Linux** run `UID=$(id -u) GID=$(id -g) docker compose up`
|
|
- On **Windows** run `docker compose up`
|
|
|
|
<details>
|
|
<summary><i>How do I open a terminal in windows?</i></summary>
|
|
|
|
---
|
|
|
|
From the file explorer, you can open a folder in **powershell** (_a modern windows terminal_):
|
|
|
|
- **hold 'Shift'** and **Right Click** on the folder.
|
|
|
|
- Select **"Open PowerShell window here"** from the popup menu.
|
|
|
|
---
|
|
|
|
</details>
|
|
|
|
3.) Docker will build the project and the ROM will be in the same location as step 7 describes below.
|
|
|
|
## **-Windows-**
|
|
Video Tutorial: https://youtu.be/72Zzo1VDYzQ?si=UDmEdbST1Cx1zZV2
|
|
### With `Git` (not required)
|
|
1.) Install `devkitPro` from https://github.com/devkitPro/installer by downloading the latest release, unzipping the archive, and then running the installer. You only need to install the tools for the GBA development so ensure you have it selected and install it to the default directory. You may need to create a temp folder for the project.
|
|
|
|
2.) Search for `MSys2` in the Start Menu and open it.
|
|
|
|
3.) Install `Git` by typing this command: `pacman -S git` if you don't have it already installed
|
|
|
|
4.) Clone the project by putting `git clone https://github.com/cellos51/balatro-gba.git` in the MSys2 window.
|
|
|
|
5.) Use `cd` and drag the new folder into the window to add the file path and press Enter.
|
|
|
|
6.) Type `make` into the window and press Enter to start building the rom.
|
|
|
|
7.) After it completes, navigate through the `build` directory in the project folder and look for `balatro-gba.gba` and load it on an emulator or flashcart.
|
|
### Without `Git`
|
|
Disregard Steps 3-4 and instead click the green code button on the main repository page and press `Download Zip`. Unzip the folder and place it wherever you like. Then continue from Step 5.
|
|
|
|
## **-Linux-**
|
|
|
|
1.) Add the devkitPro repository using these instructions https://devkitpro.org/wiki/devkitPro_pacman
|
|
|
|
2.) Install devkitPro by running `sudo pacman -S gba-dev` and accepting all packages.
|
|
|
|
3.) Activate the devkitPro environment by running `source /etc/profile.d/devkit-env.sh` or opening a new shell.
|
|
|
|
4.) Follow instructions from the Windows tutorial starting from Step 3
|
|
|
|
## **-macOS-**
|
|
1.) Install devkitPro installer using: https://github.com/devkitPro/installer and following https://devkitpro.org/wiki/devkitPro_pacman#macOS.
|
|
> Note: You may have to install the installers directly from their url in a browser, as the installer script may not install correctly due to Cloudflare checks on their server. You can use one of the following urls:
|
|
|
|
> Apple Silicon: https://pkg.devkitpro.org/packages/macos-installers/devkitpro-pacman-installer.arm64.pkg
|
|
|
|
> Intel: https://pkg.devkitpro.org/packages/macos-installers/devkitpro-pacman-installer.x86_64.pkg
|
|
|
|
2.) Run `sudo dkp-pacman -S gba-dev`
|
|
|
|
3.) Verify that devkitPro is installed in '/opt/devkitpro'
|
|
|
|
4.) Add the following to your .bashrc or .zshrc (or export the variables in your shell session):
|
|
- export DEVKITPRO=/opt/devkitpro
|
|
- export DEVKITARM=$DEVKITPRO/devkitARM
|
|
- export PATH=$PATH:$DEVKITPRO/tools/bin:$DEVKITPRO/pacman/bin
|
|
|
|
5.) Follow instructions from Windows tutorial step 4
|
|
|
|
## **Common Issues:**
|
|
|
|
#### 1. **When I run `make` it errors out and won't compile!**
|
|
- Move the project folder to your desktop and then `cd` to it by dragging the folder into the terminal window. This error could be caused by a bad file path, placing the folder on the desktop is a failsafe.
|
|
|
|
#### 2. **I can't find the compiled rom!**
|
|
- Look for a folder called `build` inside the project folder and then find `balatro-gba.gba`.
|
|
|
|
#### 3. **The Game won't start!**
|
|
- Try a different emulator or if you are using original hardware, make sure the rom is not corrupted and try a different flashcart or SD Card. If this does not work, open an issue on the Github page because a recent commit may have broke the game.
|
|
|
|
#### 4. **It says I don't have `Git` or `Make` installed!**
|
|
- Use `pacman -S git` (not required) or `pacman -S make` although make should already be installed if you followed the instructions correctly.
|
|
|
|
# **Credits:**
|
|
## **Game**
|
|
This GBA implementation is based on Balatro which is designed and created by LocalThunk and published by Playstack.
|
|
See repository contributors list for code contribution credits to this GBA implementation.
|
|
## **Music**
|
|
Music arrangement is made by @cellos51 and @MeirGavish based on original Balatro soundtrack by [LouisF](https://louisfmusic.com/) and [transcription by MrCrimit](https://musescore.com/user/8237321/scores/14590660).
|
|
## **Imagery**
|
|
Sprites and backgrounds are based on original Balatro imagery created by LocalThunk.
|
|
See [Joker Art Discussion](https://github.com/cellos51/balatro-gba/discussions/69) for full credits for each joker sprite.
|
|
## **Sounds**
|
|
For the mult and xmult sound effects: [Toy records#06-E3-02.wav by poissonmort](https://freesound.org/s/253249/) used under License: Attribution 4.0
|
|
|
|
All other sound effects were created by LocalThunk and are used under Creative Commons - CC0 license.
|