https://github.com/catizard/lampghost
Offline & Cross-platform beatoraja/LR2 lamp viewer and more
https://github.com/catizard/lampghost
beatoraja bms gui
Last synced: 5 months ago
JSON representation
Offline & Cross-platform beatoraja/LR2 lamp viewer and more
- Host: GitHub
- URL: https://github.com/catizard/lampghost
- Owner: Catizard
- License: apache-2.0
- Created: 2024-05-15T10:04:23.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-02T12:43:49.000Z (8 months ago)
- Last Synced: 2025-11-02T14:29:28.626Z (8 months ago)
- Topics: beatoraja, bms, gui
- Language: Go
- Homepage:
- Size: 11 MB
- Stars: 20
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# LampGhost
English | [简体中文](./README.zh-CN.md)
## What is LampGhost?
`LampGhost` is an **offline** and **cross-platform** `beatoraja/LR2` save file viewer, favorite folder manager and BMS downloader. It supports:
- `I18n`:`English` and `zh-CN` are supported currently
- `Clients`: We keep `LR2` user in heart, although `LampGhost` is mainly supporting `beatoraja`, we give as much as possible support to `LR2` users
- `Multiple User`: You can load your friends' save file and view/compare their scores
- `Time Machine`: "Turn back" your friend's save file time(Suppose your friend is already ^^, using `LampGhost` allows you comparing the lamp status the moment that your friend achived ★5). And even "back port" the data into beatoraja
- `Favorite Folder`: Customize favorite folder and import it as a difficult table in `beatoraja`(tip: You can reload table by pressing F2 in game). More specifically, import `http://127.0.0.1:7391/table/lampghost.json` in `beatoraja` while keep `LampGhost` opening
- `Custom Difficult Table`: Customize your own difficult table and export, share, or deploy to static website
- `Download Missing BMS`: `LampGhost` implements the integration with some BMS download servers. You can download the missing BMS manually or supply all missing BMS based on difficult tables
- `Automatic`: `LampGhost` will monitor your save files and trigger an incremental sync when finishing gameplay
Because `LampGhost` is an **offline** tool, therefore:
- No need of an `ir.jar` file for connecting a centralized server. Therefore won't be unusable due to server is down
- If you want to compare your friends' save file, you need to ask them and handle them manually, which could be a tedious task
- It's always here, when you want to see your progress, the only thing you need to do is pressing the sync button
- There might be a risk for some breaking changes that you have to remove `LampGhost`'s database file and have a clean start
> [!warning]
>
> Data is invaluable, backup your save file is highly recommanded. Although `LampGhost` would only **read** your save file but never **modify** it, but there still be some rare bug that ruin your save file
## How to download and use LampGhost?
Grab an executable at `Release` page, then double-click it. This should be working for `Windows` and `Linux`.
## Build from scratch
- Install [wails](https://github.com/wailsapp/wails)
- `wails build`
## Attentions
This project is still at early demo phase, you might encounter some mystery problem(Don't worry, won't ruin your save file most likely). You could delete the whole `LampGhost` data folder to have a clean restart:
For `Windows` user it's located at `%USERPROFILE%\.lampghost_wails`, for `Linux/OSX` user is `$HOME/.lampghost_wails`
### Unfortunate LR2 users
> [!warning]
> In short, we are not encouraging LR2 users to use `LampGhost` currently. Although the features are implemented. There's still many things we have to polish, see [#25] for more details.
> If you happens to be a LR2 user and want to use `LampGhost` as a missing BMS downloader, you can also download a `beatoraja` and let it build `songdata.db` for `LampGhost` to know what BMS you don't have.
> This might be more stable than you initialize the main user by importing LR2 files and BMS directories
LR2's database doesn't record much useful data so `LampGhost` can only provide partial support for LR2 users:
- LR2 users can view their lamps, but all features that are related to time are not useable for LR2 users. This is because LR2's score database file doesn't record when the record set. Also it's impossible to view recent activities since LR2 only records each song's best score but no play logs.
- Because LR2 doesn't provide a file like `songdata.db`, `LampGhost` provides the ability of scanning bms directories and building an equivalent of `songdata.db`. However, this is a very time-consuming task to do(it needs to scan every bms file on your disk). Currently, `LampGhost` only supports completely rebuild the file.
- You cannot add a LR2 user as a rival currently.
## Bugs reports and Advices
This project is made by my own(at least for now), so it's still very simple and biased. Any bug reports and advices are very welcomed!
## Special Thanks
- [@Yuntian](https://www.github.com/Yuntian52s): Providing ui design advices, without his selfless work `LampGhost` would still a be a very unfriendly tool
- [@Wriggle](https://www.github.com/wrigglebug): Providing bms download site [The Big Sister BMS Project](https://bms.wrigglebug.xyz/) and separate bms sabun download api.
- [@MaverickLong](https://www.github.com/MaverickLong): Providing bms download site [Konmai](https://616.sb/bms/download) and separate bms sabun download api.
- [@Sayaka](https://github.com/SayakaIsBaka): Providing bms preview site [BMS Score Viewer](https://github.com/SayakaIsBaka/bms-score-viewer)
- [@Chuang](https://github.com/chuang1213), yzy, yf and other early version testers
- [Wails](https://github.com/wailsapp/wails): This project is based on `wails` framework, and benefits a lot from its amazing hot reload time and easy mind model