otoge-db

       

OTOGE DB (音ゲーDB)

OTOGE DB is an unofficial database for viewing song information served in SEGA’s arcade music games ‘Ongeki’, ‘Chunithm’, ‘maimai DX’. Building on top of the public data provided from the official SEGA websites and extra information available on various different community contributed sites, OTOGE DB allows convenient lookup of latest song information through the thoughtfully designed web interface.

OTOGE DBはSEGAの音ゲー「オンゲキ」「CHUNITHM」「maimaiでらっくす」の非公式収録曲データベースサイトです。公式サイトで公開されているデータを基にして、Wikiなどウェブで入手できる情報を集めて一箇所で楽に見れるようにする目標で作られました。

Setting up dev environment

• Prerequisites: Node.js (v18+) and Python 3.12+
• Run the one-step automated setup:

  yarn install
  yarn setup
  

  This will automatically create .venv, install Python requirements, and compile all assets. (No manual source .venv/bin/activate is required when running yarn scripts!)

Run scripts

• yarn fetch-songs : Download new song and images from server

  Arguments for all scripts:

  Argument	Description
  --ongeki --chunithm --maimai	(Required) Run script for specified game (Set only one at a time)
  --nocolors	Don't print colors to terminal messages
  --markdown	Print messages in Github flavored markdown format (for PR messages)
  --escape	Escape unsafe characters for git message output (Song titles with symbols, etc)
  --no_timestamp	Don't print timestamps on message output
  --no_verbose	Only print significant changes and errors

• yarn fetch-intl : Fetch international version song availability & date info from SilentBlue (remywiki)

  Script specific-arguments:

  Argument	Description
  --strict	Strict match songs by checking levels for all charts (If not set, script will proceed to update songs by just matching song title and artist names.)

• yarn fetch-wiki : Fetch extra song data from wiki

  Script specific-arguments:

  Argument	Description
  --date	Set specific date to target songs. (Example: --date 20230101) If unset, script fetches for the latest datestamp in music-ex.json file.
  --date_from	Set start of date range to target songs. (Example: --date_from 20230101) If unset, script fetches for the latest datestamp in music-ex.json file.
  --date_until	Set end of date range to target songs. (Example: --date_until 20231231) If unset, script fetches for the latest datestamp in music-ex.json file.
  --id	Run script for a single song. Can't be used together with the date target arguments above. (Example: --id 2524)
  --all	Run script for all songs. (Warning: may cause heavy traffic load to the wiki sites so may get you banned temporarily. Be careful especially when using with --noskipoption!!)
  --noskip	Don't skip items that already have URL
  --overwrite	Overwrite keys that already have values

• yarn fetch-const : Fetch song constants

  Script specific-arguments:

  Argument	Description
  --date	Set specific date to target songs. (Example: --date 20230101) If unset, script fetches for the latest datestamp in music-ex.json file.
  --date_from	Set start of date range to target songs. (Example: --date_from 20230101) If unset, script fetches for the latest datestamp in music-ex.json file.
  --date_until	Set end of date range to target songs. (Example: --date_until 20231231) If unset, script fetches for the latest datestamp in music-ex.json file.
  --id	Run script for a single song. Can't be used together with the date target arguments above. (Example: --id 2524)
  --overwrite	Overwrite keys that already have values
  --clear_cache	Clears local cache on run
  --legacy	Match with legacy sgimera format

• yarn fetch-chartguide : Fetch chart guide links from sdvx.in

  Script specific-arguments:

  Argument	Description
  --date	Set specific date to target songs. (Example: --date 20230101) If unset, script fetches for the latest datestamp in music-ex.json file.
  --date_from	Set start of date range to target songs. (Example: --date_from 20230101) If unset, script fetches for the latest datestamp in music-ex.json file.
  --date_until	Set end of date range to target songs. (Example: --date_until 20231231) If unset, script fetches for the latest datestamp in music-ex.json file.
  --id	Run script for a single song. Can't be used together with the date target arguments above. (Example: --id 2524)
  --overwrite	Overwrite keys that already have values
  --clear_cache	Clears local cache on run

Notes for Local Development

Development & Build Scripts

• yarn dev : Starts the local development server (with live reload) and watches for changes across Pug, LESS, and JS source files.
• yarn build : Compiles Pug templates, LESS stylesheets (with PostCSS autoprefixer & cssnano), and minifies JS with esbuild.
• yarn build:pug / yarn build:less / yarn build:js : Build individual asset categories.

Notes

• This webpage is hosted and run entirely on Github Pages without any additional backend servers attached.
• {game_name}/data/music.json and maimai/data/maimai_songs.json : Copy of original JSON file provided by SEGA as-is
• {game_name}/data/music-ex.json: Augmented JSON file containing additional data not provided by the official website
• {game_name}/data/music-ex-intl.json: Augmented JSON file containing song information for International version
• {game_name}/data/music-ex-deleted.json: JSON file containing deleted song information for archive purposes

Credits

Main Contributors

• @mantou1233 : Bug reporting, data contributions, PR reviews, feature development
• @ssankim : Wiki fetch script & Github Actions workflow help
• @kiding : Script for updating datestamps after fetch
• @Ryudnar : Early script foundation for song data downloading

Other Contributors

• @u7gisan, @TSUBAKI_ONGEKI, @RKS49019722, @Rinsaku471, @46189_ext, @hikkey7th, @suoineau_ac, @hayato_ongeki

Data Sources

Ongeki

• SEGA Official Music Data : base JSON file
• オンゲキ攻略wiki : BPM, Enemy type, Enemy Lv, Chart note details, Chart designer
• オンゲキ譜面保管所 : BPM, Chart designer, Chart guide links
• オンゲキbright MEMORY Act.3 譜面定数表 : Chart constants (譜面定数)

Chunithm

• SEGA Official Music Data : base JSON file
• CHUNITHM攻略wiki : BPM, Chart note details, Chart designer
• CHUNITHM譜面保管所 : BPM, Chart designer, Chart guide links
• CHUNITHM LUMINOUS 譜面定数表 : Chart constants (譜面定数)
• CHUNITHM VERSE 譜面定数表 : Chart constants (譜面定数)

maimai

• SEGA Official Music Data : base JSON file
• maimai 攻略wiki : BPM, Chart note details, Chart designer
• maimai DX PRiSM譜面定数表 : Chart constants (譜面定数)
• 内部Lv.の表 PRiSM ver.(sgimera) : Chart constants (譜面定数)

Feedback

• Contact @otoge_db or @zvuc_ for any suggestions or inquiries.
• お問い合わせなどは上記のアカウントまでお願いします。

Copyright

• MIT License for all code in this repository.
• All vector image assets used in this website have been produced independently from scratch, however intellectual rights for the original designs remain to SEGA.
• ONGEKI, CHUNITHM, maimai でらっくす and the respective logos are trademarks of SEGA.
• All song jacket images are owned by SEGA and/or their respective owners.
• OTOGE DB is a fan project. It is not afilliated with nor endorsed by SEGA in any way.
• OTOGE DBは非公式ファンメイドプロジェクトです。株式会社セガもしくは他の関連会社との関係はありません。