From 181708776b2ef7818643711c37d638db3856fad6 Mon Sep 17 00:00:00 2001 From: Mikhail Date: Wed, 3 Jul 2024 16:48:40 -0400 Subject: [PATCH 1/8] Update README.md --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 62da984..30013ed 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,13 @@ Private/local server for Nikke. NOTE: This project is in a very early state. ## Usage +Download the latest release/GitHub actions build, and run ServerSelector.Desktop.exe as administrator (to modify DNS hosts file and install a CA cert). Make sure to close the game and launcher first. Select Local server, and then click save. + +You should be able to register an new account in the launcher (you can enter any email verification code). + +If the game does not get past the title screen, open an issue and send %appdata%\..\LocalLow\com.proximabeta\NIKKE\player.log file. + +## Manual installation First, build and run nksrv project. Next, open libsodium-1.0.18-RELEASE/libsodium.sln and build that as well. Ignore the failed tests as the encryption public key was hardcoded. After that, add the following to your C:\Windows\System32\hosts or /etc/hosts file to use the local server: From 6573ee816a7cc4f9a96c5bb2b0fd3ab699c42d54 Mon Sep 17 00:00:00 2001 From: Mikhail Date: Wed, 3 Jul 2024 16:49:02 -0400 Subject: [PATCH 2/8] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 30013ed..ca517c2 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,10 @@ After that, add the following to your C:\Windows\System32\hosts or /etc/hosts fi Run generate_ssl_cert.sh in WSL or linux to generate SSL certificates. Make sure to trust myCA.pfx. Append the following (with your CA cert pem that you generated) to Launcher/intl_service/cacert.pem and NIKKE/game/nikke_Data/Plugins/cacert.pem -Good SSL CA +```Good SSL CA =============================== - +``` As Nikke encrypts packet data, you also need to replace C:\NIKKE\NIKKE\game\nikke_Data\Plugins\x86_64\sodium.dll from the one you built. NOTE: Make sure to undo these modifications (especially change back sodium.dll) to play on the offical servers. From 2c2056c834a44abdb0b63e07dcf1abbd3be52424 Mon Sep 17 00:00:00 2001 From: Mikhail Date: Wed, 3 Jul 2024 16:49:15 -0400 Subject: [PATCH 3/8] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ca517c2..f87524b 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,8 @@ After that, add the following to your C:\Windows\System32\hosts or /etc/hosts fi Run generate_ssl_cert.sh in WSL or linux to generate SSL certificates. Make sure to trust myCA.pfx. Append the following (with your CA cert pem that you generated) to Launcher/intl_service/cacert.pem and NIKKE/game/nikke_Data/Plugins/cacert.pem -```Good SSL CA +``` +Good SSL CA =============================== ``` From 9d7792e60b2d0fcfa44a34a98d2c443aba682316 Mon Sep 17 00:00:00 2001 From: Mikhail Date: Wed, 3 Jul 2024 16:49:40 -0400 Subject: [PATCH 4/8] Update README.md --- README.md | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index f87524b..a919b03 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,25 @@ You should be able to register an new account in the launcher (you can enter any If the game does not get past the title screen, open an issue and send %appdata%\..\LocalLow\com.proximabeta\NIKKE\player.log file. +## Progress +Stage, character, and story information is saved and works, as well as player nickname. +TODO: Gacha system, reward system (works but does not show in UI), xp system, sim room, outpost, etc +TODO: Create a custom launcher that allows switching between offical/local server easily. + +TODO: Provide screenshots + + +## Contributing +Server code structure: + +nksrv/LobbyServer: Handles save data. + +nksrv/IntlServer: Provides Launcher APIs and authentication + +nksrv/Protos: Google protobuf definition files + +DataFixupUtil: Utility to parse packets from server/client + ## Manual installation First, build and run nksrv project. Next, open libsodium-1.0.18-RELEASE/libsodium.sln and build that as well. Ignore the failed tests as the encryption public key was hardcoded. @@ -37,22 +56,3 @@ As Nikke encrypts packet data, you also need to replace C:\NIKKE\NIKKE\game\nikk NOTE: Make sure to undo these modifications (especially change back sodium.dll) to play on the offical servers. After doing the following steps, you can register an account in the launcher (enter anything into email verification code section), and play like normal. - -## Progress -Stage, character, and story information is saved and works, as well as player nickname. -TODO: Gacha system, reward system (works but does not show in UI), xp system, sim room, outpost, etc -TODO: Create a custom launcher that allows switching between offical/local server easily. - -TODO: Provide screenshots - - -## Contributing -Server code structure: - -nksrv/LobbyServer: Handles save data. - -nksrv/IntlServer: Provides Launcher APIs and authentication - -nksrv/Protos: Google protobuf definition files - -DataFixupUtil: Utility to parse packets from server/client From de2db4d2b6f73147338af6816b3a4aac2e1906b9 Mon Sep 17 00:00:00 2001 From: Mikhail Date: Wed, 3 Jul 2024 16:53:54 -0400 Subject: [PATCH 5/8] Add screenshots --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a919b03..7a2aaa4 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,18 @@ Download the latest release/GitHub actions build, and run ServerSelector.Desktop You should be able to register an new account in the launcher (you can enter any email verification code). If the game does not get past the title screen, open an issue and send %appdata%\..\LocalLow\com.proximabeta\NIKKE\player.log file. +![image](https://github.com/MishaProductions/nikke-server/assets/106913236/b01194ef-aec5-4de9-b982-1253757655f8) + ## Progress Stage, character, and story information is saved and works, as well as player nickname. -TODO: Gacha system, reward system (works but does not show in UI), xp system, sim room, outpost, etc -TODO: Create a custom launcher that allows switching between offical/local server easily. +TODO: reward system (works but does not show in UI), xp system, sim room, outpost, etc +TODO: Create a launcher replacement -TODO: Provide screenshots +![image (2) (Custom)](https://github.com/MishaProductions/nikke-server/assets/106913236/75330e0d-ddb5-4d29-b7dd-ab6662306494) +![image](https://github.com/MishaProductions/nikke-server/assets/106913236/15b5ea93-bcd1-44b7-81b9-a10d053b7af8) +![image](https://github.com/MishaProductions/nikke-server/assets/106913236/70ab4668-70b8-4e2c-bf1b-c84974f5e8ee) +![image](https://github.com/MishaProductions/nikke-server/assets/106913236/c6a89fd4-9568-48c2-b4f9-d73807d4043e) ## Contributing From 553713c4aa6c53cebfea4ec50c492fb6065dd369 Mon Sep 17 00:00:00 2001 From: Mikhail Date: Wed, 3 Jul 2024 16:59:27 -0400 Subject: [PATCH 6/8] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7a2aaa4..e0081af 100644 --- a/README.md +++ b/README.md @@ -15,10 +15,10 @@ Stage, character, and story information is saved and works, as well as player ni TODO: reward system (works but does not show in UI), xp system, sim room, outpost, etc TODO: Create a launcher replacement -![image (2) (Custom)](https://github.com/MishaProductions/nikke-server/assets/106913236/75330e0d-ddb5-4d29-b7dd-ab6662306494) -![image](https://github.com/MishaProductions/nikke-server/assets/106913236/15b5ea93-bcd1-44b7-81b9-a10d053b7af8) -![image](https://github.com/MishaProductions/nikke-server/assets/106913236/70ab4668-70b8-4e2c-bf1b-c84974f5e8ee) -![image](https://github.com/MishaProductions/nikke-server/assets/106913236/c6a89fd4-9568-48c2-b4f9-d73807d4043e) + + + + ## Contributing From e6b23690f1f72d6641560b1bb30bd9704291a285 Mon Sep 17 00:00:00 2001 From: Mikhail Date: Wed, 3 Jul 2024 17:00:05 -0400 Subject: [PATCH 7/8] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e0081af..5703378 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Download the latest release/GitHub actions build, and run ServerSelector.Desktop You should be able to register an new account in the launcher (you can enter any email verification code). If the game does not get past the title screen, open an issue and send %appdata%\..\LocalLow\com.proximabeta\NIKKE\player.log file. -![image](https://github.com/MishaProductions/nikke-server/assets/106913236/b01194ef-aec5-4de9-b982-1253757655f8) + ## Progress From 50241941a6c2546c2ac2e9e5c4f98b97bf833f8c Mon Sep 17 00:00:00 2001 From: Mikhail Date: Wed, 3 Jul 2024 17:02:40 -0400 Subject: [PATCH 8/8] Update README.md --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5703378..3cf704d 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,13 @@ Private/local server for Nikke. NOTE: This project is in a very early state. ## Usage Download the latest release/GitHub actions build, and run ServerSelector.Desktop.exe as administrator (to modify DNS hosts file and install a CA cert). Make sure to close the game and launcher first. Select Local server, and then click save. - +
+ +
You should be able to register an new account in the launcher (you can enter any email verification code). If the game does not get past the title screen, open an issue and send %appdata%\..\LocalLow\com.proximabeta\NIKKE\player.log file. - + ## Progress