Skip to content

Catizard/lampghost

Repository files navigation

LampGhost

English | 简体中文

What is LampGhost?

showcase1 showcase2

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
  • 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: Providing ui design advices, without his selfless work LampGhost would still a be a very unfriendly tool
  • @Wriggle: Providing bms download site The Big Sister BMS Project and separate bms sabun download api.
  • @MaverickLong: Providing bms download site Konmai and separate bms sabun download api.
  • @Sayaka: Providing bms preview site BMS Score Viewer
  • @Chuang, yzy, yf and other early version testers
  • Wails: This project is based on wails framework, and benefits a lot from its amazing hot reload time and easy mind model

About

Offline & Cross-platform beatoraja/LR2 lamp viewer and more

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •