|
1 | | -# worldlinkd |
| 1 | +# WorldLink |
2 | 2 |
|
3 | | -This project was created using the [Ktor Project Generator](https://start.ktor.io). |
| 3 | +WorldLink maimai DX Online C2C Multiplayer Mod |
4 | 4 |
|
5 | | -Here are some useful links to get you started: |
| 5 | +> ![WARNING] |
| 6 | +> This mod is in beta testing, please report any bugs you find. |
6 | 7 |
|
7 | | -- [Ktor Documentation](https://ktor.io/docs/home.html) |
8 | | -- [Ktor GitHub page](https://github.com/ktorio/ktor) |
9 | | -- The [Ktor Slack chat](https://app.slack.com/client/T09229ZC6/C0A974TJ9). You'll need |
10 | | - to [request an invite](https://surveys.jetbrains.com/s3/kotlin-slack-sign-up) to join. |
| 8 | +## Playing WorldLink |
11 | 9 |
|
12 | | -## Features |
| 10 | +### On PC & Controller |
13 | 11 |
|
14 | | -Here's a list of features included in this project: |
| 12 | +1. Install [MelonLoader](https://github.com/LavaGang/MelonLoader#install) |
| 13 | +2. Download [WorldLink.dll](https://github.com/MewoLab/worldlinkd/releases/latest/download/WorldLink.dll), put it in Mods |
| 14 | +3. Download [WorldLink.toml](https://github.com/MewoLab/worldlinkd/blob/main/mod/WorldLink.toml) |
| 15 | +4. Edit `WorldLink.toml` to select a lobby server |
| 16 | +5. Start the game |
15 | 17 |
|
16 | | -| Name | Description | |
17 | | -| ------------------------------------------------------------------------|------------------------------------------------------------------------------------ | |
18 | | -| [Routing](https://start.ktor.io/p/routing) | Provides a structured routing DSL | |
19 | | -| [Content Negotiation](https://start.ktor.io/p/content-negotiation) | Provides automatic content conversion according to Content-Type and Accept headers | |
20 | | -| [kotlinx.serialization](https://start.ktor.io/p/kotlinx-serialization) | Handles JSON serialization using kotlinx.serialization library | |
| 18 | +### On KanadeDX |
21 | 19 |
|
22 | | -## Building & Running |
| 20 | +1. Go to launcher settings in the top right |
| 21 | +2. Click on the "mods" tab |
| 22 | +3. Scroll down to find WorldLink, enable it |
| 23 | +4. Fill in the WorldLink URL |
| 24 | +5. Start the game |
23 | 25 |
|
24 | | -To build or run the project, use one of the following tasks: |
| 26 | +## Play Manual |
25 | 27 |
|
26 | | -| Task | Description | |
27 | | -| -------------------------------|---------------------------------------------------------------------- | |
28 | | -| `./gradlew test` | Run the tests | |
29 | | -| `./gradlew build` | Build everything | |
30 | | -| `buildFatJar` | Build an executable JAR of the server with all dependencies included | |
31 | | -| `buildImage` | Build the docker image to use with the fat JAR | |
32 | | -| `publishImageToLocalRegistry` | Publish the docker image locally | |
33 | | -| `run` | Run the server | |
34 | | -| `runDocker` | Run using the local docker image | |
| 28 | +1. You and your friend both connect to the same lobby |
| 29 | +2. One person select a song and difficulty, scroll to the left, and click recruit |
| 30 | +3. The other person join in the song-select menu |
35 | 31 |
|
36 | | -If the server starts successfully, you'll see the following output: |
37 | | - |
38 | | -``` |
39 | | -2024-12-04 14:32:45.584 [main] INFO Application - Application started in 0.303 seconds. |
40 | | -2024-12-04 14:32:45.682 [main] INFO Application - Responding at http://0.0.0.0:8080 |
41 | | -``` |
| 32 | +## Running a Server |
42 | 33 |
|
| 34 | +If you want to self-host a server to play with your friends, read the [Self Host Guide](README.HOST.md). |
0 commit comments