MaiMaiDXNet/readme.md

# Open Source MaiMaiDX.Net Interface

This is a Open Source MaiMaiDX.Net Interface.

### This Interface Requires a Server Database.

Artemis & Aqua are Supported, see the `How To Use` Section for more details.

### Features

Functional MaiMaiDX Profile Playlog, Memorial Photo (Aqua Only), and Area Tracker.

Coming Soon: Addable & Viewable Friends Profiles, Song Records, viewable Collections, Server Ranking?

# How to use:

## All Servers

You'll need to extract the assets from the game itself.

in the public folder, the assets should look like this
```
-- Public
| - Assets
\_ | - icon
   | - jacket
   | - metadata
```

Then, create the `/public/image/` folder. this will be where the images will be stored.

You'll also need the Game metadata, extracted using [SegaParser](https://dev.s-ul.net/Galexion/segaparser),
to get the game metadata. this is ***Nessasary*** for the interface to function.



## Aqua

Create a `config.json` file and paste this in, with paths to your instance.

```json
{
    "serverType": 0,
    "aquaSrvDir": "A:\\path\\to\\aqua\\data",
    "ArtConnSettings": {
        "host":"192.168.smt.hng",
        "user":"MaiDXNet",
        "password":"aSecurePassword"
    },
    "imageFolder": "N:\\MaiMaiDXNet\\public\\images",
    "hostPort": "8000"
}
```

`serverType` selects between Aqua (0), and Artemis (1).

Note: you want to enter into the `data` folder in `aquaSrvDir`.

Note: `imageFolder` leads to the `/public/images` folder of the directory.

## Artemis

Create a `config.json` file and paste this in, with paths to your instance.

```json
{
    "serverType": 1,
    "ArtImageImport": true,
    "ArtImageDirectory":"S:\\Artemis\\Server\\Image\\Directory",
    "ArtConnSettings": {
        "connectionLimit": "2",
        "host":"192.168.smt.hng",
        "user":"MaiDXNet",
        "pass":"aSecurePassword"
    },
    "imageFolder": "N:\\MaiMaiDXNet\\public\\images",
    "hostPort": "8000"
}
```

`serverType` selects between Aqua (0), and Artemis (1).

Edit `ArtConnSettings` to be configured for your server.

Modify and use this command string in your terminal to create and set up permissions for The MaiDXNet account.

```sql
CREATE USER 'MaiDXNet'@'%' IDENTIFIED BY 'aSecurePassword';
GRANT Alter,Create,Delete,Drop,Index,Insert,References,Select,Update ON aime.* TO 'MaiDXNet'@'%';
```

Note: you'll need to configure `mai2.yaml` to enable Photo Sending to Artemis. Ensure that you have a image directory ready.

```yaml
  photos: True
  photos_dir: "S:\\Artemis\\Server\\Image\\Directory"
  movies: false
  movies_dir: "S:\\Artemis\\Server\\Movie\\Directory"
```

If you can't update Artemis to a version that supports Photo Exporting, or simply don't want to use Memorial Photo's, please set `"ArtImageImport": false`.

# Project Progress

Goal for Milestone 1:
- Get all tabs showing with ***Some*** Functionality (2/6)
    - PlayLog (Done)
    - Photos
    - Area (Done)
    - Collection
    - Ranking
    - Options
    
ToDo:
- Create Play Data Tab
    - Get User Playlog Data (Done)
    - Sort From Most Recent (Done)
    - Assign Song Names to Each Score (done)
    - Re-Create the MaiMaiDXNet Playlog list (90% Done, can't continue without image assets that are only on the offical Server)
    - Create Detailed Look Into Score
- Create Photos Tab
    - Create a rudementrary Photos tab until i can finallly get my hands on images of the Photos tab in MaiMai DX Net
- Create Area Tab
    - Get User Area Data (Done)
    - Get Metadata for Area (Done)
    - Show if Area is complete (Done)
    - Show Kilometers left until Next Reward (Done+, you can also see if you have a Task Track you need to complete)
    - create what ever is in the details tab
- Create Collection Tab
- Create Ranking Tab
- Create Options Tab
- add a background i guess

Complete:
- Sign In Page
- Make User Profile on User Page (done)
    - Fuck you css go kill yourself
- Ban button
    - lmao
    - ok actually this is pretty cool