Phigros Info Collector, powering PhiZone

A Java program that crawls information of Phigros from the web. Meanwhile the program behind PhiZone.

What This Program Does

This program visits the wiki from which it crawls information of songs in Phigros.
Then it converts the information into separate JSON files, which are then respectively put into different song folders.
Using the information it crawls, we're then able to quickly find chart files for each individual song by checking the number of notes, BPM, etc.

Having sorted them out, we're nowhere far from creating a file server for Phigros!

What We Provide You With

We've hosted a website called PhiZone, which serves the information mentioned above.

Feel free to visit the file server at:

• https://files.phi.zone (self-hosted server in Hong Kong, indexed)
• https://api.neonmc.top:6600 (self-hosted server in Beijing, indexed)
• https://phi-zone.github.io (GitHub mirror, not indexed)

Apart from audio files and illustrations, all the text information is served in JSON format, which is easy to parse using programs.

By this means, accessing Phigros information becomes easier.

Usage

As said above, there's no need to clone this repository.
All you need to do is parse the information that you get from PhiZone file server.

Structure of Files

The File Tree

Having an overview of the structure of our files before specifically learning about each file is rather a good idea.

(root)
├── info.json
├── covers
│   ├── chapter-4.png
│   ├── chapter-5-locked.png
│   ├── chapter-5.png
│   ├── chapter-6-locked.png
│   ├── chapter-6.png
│   ├── chapter-7-locked.png
│   ├── chapter-7.png
│   ├── chapter-ex-good.png
│   ├── chapter-ex-hyun.png
│   ├── chapter-ex-jiangmitiao.png
│   ├── chapter-ex-muse-dash.png
│   ├── chapter-ex-rising-sun-traxx.png
│   ├── chapter-ex-waveat.png
│   ├── chapter-legacy.png
│   ├── phigros.png
│   ├── side-story-1.png
│   └── single.png
├── chapter-4
│   ├── info.json
│   ├── bonus-time
│   ├── class-memories
│   ├── energy-synergy-matrix
│   ├── sultan-rage
│   └── surrealism
├── chapter-5
│   ├── info.json
│   ├── cryout
│   ├── junxion-between-life-and-death(vip-mix)
│   └── ...
├── chapter-6
│   └── ...
├── chapter-7
│   └── ...
├── chapter-ex-good
│   └── ...
├── chapter-ex-rising-sun-traxx
│   └── ...
├── chapter-legacy
│   └── ...
├── hidden
│   ├── info.json
│   ├── burn(haocore-mix)
│   ├── christmas
│   ├── spasmodic(haocore-mix)
│   └── wintercube-(original-mix)
├── introduction
│   ├── info.json
│   ├── introduction
│   └── introduction-(2.0-ver.)
├── side-story-1
│   ├── info.json
│   ├── lyrith-meikyuuririsu
│   ├── miracle-forest-(vip-mix)
│   └── ...
├── single
│   └── ...
├── unavailable
│   ├── info.json
│   ├── anomaly
│   └── destination
└── ...

The structure of each song's folder is as follows:

mopemope
├── Chart_AT.json
├── Chart_EZ.json
├── Chart_HD.json
├── Chart_IN.json
├── Chart_SP.json
├── illustration.png
├── info.json
└── music.wav

The Summary File

As shown above, you can first visit the info.json in the root directory, whose structure is as follows (excerpted):

{
  "version": "2.0.1",
  "last-updated-ts": 1637147959,
  "last-updated": "2021-11-17 19:19:19",
  "cover": "covers/phigros.png",
  "songs": 128,
  "chapters": [
    {
      "name": {
        "subtitle": "Chapter 5",
        "title": "霓虹灯牌"
      },
      "direct": true,
      "loc": "chapter-5/",
      "cover": "covers/chapter-5.png",
      "cover-locked": "covers/chapter-5-locked.png",
      "songs": 7
    },
    {
      "name": {
        "subtitle": "Side Story 1",
        "title": "忘忧宫"
      },
      "direct": true,
      "loc": "side-story-1/",
      "cover": "covers/side-story-1.png",
      "songs": 5
    },
    {
      "name": {
        "subtitle": "Chapter EX",
        "title": "Rising Sun Traxx 精选集"
      },
      "direct": true,
      "loc": "chapter-ex-rising-sun-traxx/",
      "cover": "covers/chapter-ex-rising-sun-traxx.png",
      "songs": 5
    },
    {
      "name": {
        "subtitle": "Single",
        "title": "单曲集"
      },
      "direct": true,
      "loc": "single/",
      "cover": "covers/single.png",
      "songs": 56
    },
    {
      "name": {
        "subtitle": "Hidden",
        "title": "隐藏曲目"
      },
      "direct": true,
      "loc": "hidden/",
      "songs": 4
    },
    {
      "name": {
        "subtitle": "Introduction",
        "title": "新手教程"
      },
      "direct": true,
      "loc": "introduction/",
      "songs": 2
    },
    {
      "name": {
        "subtitle": "Unavailable",
        "title": "已下架曲目"
      },
      "direct": true,
      "loc": "unavailable/",
      "songs": 2
    },
    {
      "name": {
        "subtitle": "Chapter EX",
        "title": "姜米條 精选集"
      },
      "direct": false,
      "cover": "covers/chapter-ex-jiangmitiao.png",
      "songs": 2
    }
  ]
}

Specifically, version represents the current version of Phigros of which we provide information, last-updated-ts and last-updated represent the time when the files have been last updated, respectively in the UNIX timestamp format and a human-readable format.

Then comes the location of Phigros all-in-one chapter's cover (which is covers/phigros.png), followed by the total number of songs in Phigros.

In the chapter array, there are several JSON objects, each representing one chapter.
The name of a chapter is represented in two strings: subtitle and title.
Then the boolean value direct represents whether this chapter has its own folder or not. Specifically, if it is true, then there's a folder created for this chapter, where all the songs in the chapter are present, and there'll be a string called loc followed by, representing the folder's relative path; otherwise, it means the chapter won't have its own folder.
If the chapter is available in game, then there'll be a string called cover representing the relative path of the cover illustration of the chapter. Moreover, if there's a cover specifically designed for the chapter when its theme song is locked, there's cover-locked following after.
At last, there comes the number of songs in the chapter.

The Chapter Info File

The info.json in each chapter's folder looks as follows:

{
  "name": {
    "subtitle": "Side Story 1",
    "title": "忘忧宫"
  },
  "songs": [
    {
      "name": "Ποσειδών",
      "loc": "poseidon/"
    },
    {
      "name": "WATER",
      "loc": "water/"
    },
    {
      "name": "Miracle Forest (VIP Mix)",
      "loc": "miracle-forest-(vip-mix)/"
    },
    {
      "name": "MOBILYS",
      "loc": "mobilys/"
    },
    {
      "name": "Lyrith -迷宮リリス-",
      "loc": "lyrith-meikyuuririsu/"
    }
  ]
}

The structure is easy to understand, so no further description is provided here.

The Song Info File

The info.json in each song's folder is formatted as follows:

{
  "name": "もぺもぺ",
  "illustration": "https://zh.moegirl.org.cn/Special:FilePath/Mopemope phi.png",
  "charts": [
    {
      "level": "EZ",
      "difficulty1": 3,
      "difficulty2": 3.4,
      "notes": 125,
      "charter": "阿爽 fixed by Barbarianerman"
    },
    {
      "level": "HD",
      "difficulty1": 8,
      "difficulty2": 8.5,
      "notes": 289,
      "charter": "阿爽 fixed by Barbarianerman"
    },
    {
      "level": "IN",
      "difficulty1": 11,
      "difficulty2": 11.1,
      "notes": 412,
      "charter": "阿爽"
    },
    {
      "level": "AT",
      "difficulty1": 14,
      "difficulty2": 14.9,
      "notes": 720,
      "charter": "阿爽"
    },
    {
      "level": "SP",
      "difficulty1": "?",
      "difficulty2": "?",
      "notes": 720,
      "charter": "阿爽"
    }
  ],
  "chapter": {
    "subtitle": "Single",
    "title": "单曲集"
  },
  "composer": "LeaF",
  "bpm": "100",
  "illustrator": "Cycats",
  "length": "1:50"
}

To be specific, the illustration of the song, apart from downloadable using the link at illustration, is already in the song's folder with the name of illustration.png. The audio file is also available in the folder, named music.wav. We've nicely converted them into JPG and OGG format respectively, too.

For each chart of the song, there is a string level representing whether it is EZ, HD, IN, AT, Legacy, or SP.
It is notable that, generally, difficulty1 (known as "定级" in Chinese) is an integer value representing the difficulty of the chart, while difficulty2 (known as "定数" in Chinese) is a float representation of the difficulty of the chart.
Specially, some charts of a new song after an update might not have its float-represented difficulty confirmed immediately. In this case, there should have appended a question mark surrouded by brackets (?) after it.
Moreover, if the level of the chart is SP, both two difficulty representations are strings with a question mark.
In all, it is highly recommended your program read strings from the two difficulty representations if not for analyzing purposes.
What is followed by is an integer value notes representing the number of notes in the chart, together with a string charter representing the author of the chart.

At last, bpm, which represents the beat-per-minute value(s) of the song, is always a string, for there might be multiple BPM values that one song uses (in this case it is formatted as a-b, where a stands for the minimal BPM value, and b stands for the maximal one).
Moreover, length, representing the length of the song, is also always a string.

Accessing Information

1. First you'd need to visit https://files.phi.zone/info.json in order to access the summary file info.json in the root directory. From that file you will find the relative path of each chapter's folder.
   Moreover, to access the cover illustration of a chapter, just find the path by its cover string or cover-locked string.
2. Once you've entered the folder of a chapter, access the chapter info file info.json located right inside the folder. In the file you'll find the path to each song's folder.
3. Having entered the folder of a song, you should read the song info file info.json in the folder to acknowledge the song's name, charts, composer, illustrator, etc.
   Then you can find chart files by listing files in the folder whose name ends with ".json". Specifically, the name of each chart file is as Chart_%s.json, where %s is a level string that can be found in the song info file.
   As mentioned before, the illustration of the song is named illustration.png and illustration.jpg, and the audio is named music.wav and music.ogg.